Skip to content

Commit

Permalink
Add links to guides for Micronaut OpenAPI (#1349)
Browse files Browse the repository at this point in the history
* 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 <sergio.delamo@softamo.com>
  • Loading branch information
wetted and sdelamo committed Dec 18, 2023
1 parent b40b7e5 commit 602252d
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/main/docs/guide/convertToAdoc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 3 additions & 0 deletions src/main/docs/guide/openApiGuides.adoc
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions src/main/docs/guide/openApiViews/swaggerui.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 1 addition & 0 deletions src/main/docs/guide/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,6 @@ serverContext:
compileResolution: Compile Time Resolution
serverFilter: HttpServerFilter
urlParameter: URL Parameter
openApiGuides: Guides
repository: Repository
breaks: Breaking Changes

0 comments on commit 602252d

Please sign in to comment.