Add links to guides for Micronaut OpenAPI (#1349)

* Add links to guides for Micronaut OpenAPI * Update src/main/docs/guide/openApiGuides.adoc * Update src/main/docs/guide/openApiViews/swaggerui.adoc * Update src/main/docs/guide/convertToAdoc.adoc --------- Co-authored-by: Sergio del Amo <[email protected]>
micronaut-projects · Dec 18, 2023 · 602252d · 602252d
1 parent b40b7e5
commit 602252d
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/src/main/docs/guide/convertToAdoc.adoc b/src/main/docs/guide/convertToAdoc.adoc
@@ -19,3 +19,5 @@ Adoc generator based on Apache Freemarker templates, and you can override full t
 |`micronaut.openapi.adoc.output.filename` | Final `adoc` file name. | Default: the same as openapi spec. filename
 |`micronaut.openapi.adoc.templates.*` | Prefix for custom template names. You can override any of the templates that are used in the default implementation to change only part of the resulting document. |
 |===
+
+TIP: See the guide for https://guides.micronaut.io/latest/micronaut-openapi-adoc.html[Generate API Documentation in AsciiDoc with the generated OpenAPI specification of your Micronaut application.] to learn more.
diff --git a/src/main/docs/guide/openApiGuides.adoc b/src/main/docs/guide/openApiGuides.adoc
@@ -0,0 +1,3 @@
+See the following list of guides to learn more about working with OpenAPI in the Micronaut Framework:
+
+https://guides.micronaut.io/latest/tag-open_api.html
diff --git a/src/main/docs/guide/openApiViews/swaggerui.adoc b/src/main/docs/guide/openApiViews/swaggerui.adoc
@@ -51,3 +51,5 @@ micronaut:
 ----
 
 With the above configuration in place when you run your application you can access your Swagger documentation at +http://localhost:8080/swagger-ui+.
+
+TIP: See the guide for https://guides.micronaut.io/latest/micronaut-openapi-swagger-ui.html[Visualize with Swagger UI an OpenAPI specification of your Micronaut application.] to learn more.
diff --git a/src/main/docs/guide/toc.yml b/src/main/docs/guide/toc.yml
@@ -62,5 +62,6 @@ serverContext:
   compileResolution: Compile Time Resolution
   serverFilter: HttpServerFilter
   urlParameter: URL Parameter
+openApiGuides: Guides
 repository: Repository
 breaks: Breaking Changes