Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add links to guides for Micronaut OpenAPI #1349

Merged
merged 4 commits into from
Dec 18, 2023
Merged

Add links to guides for Micronaut OpenAPI #1349

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5357f93
Add links to guides for Micronaut OpenAPI
wetted Dec 11, 2023
7b53db9
Update src/main/docs/guide/openApiGuides.adoc
sdelamo Dec 12, 2023
8ac90e7
Update src/main/docs/guide/openApiViews/swaggerui.adoc
sdelamo Dec 12, 2023
9a615c5
Update src/main/docs/guide/convertToAdoc.adoc
sdelamo Dec 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/main/docs/guide/convertToAdoc.adoc
View file
Open in desktop
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.
sdelamo marked this conversation as resolved.
Show resolved Hide resolved
sdelamo marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 3 additions & 0 deletions src/main/docs/guide/openApiGuides.adoc
View file
Open in desktop
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 (Swagger) in the Micronaut Framework:
sdelamo marked this conversation as resolved.
Show resolved Hide resolved
sdelamo marked this conversation as resolved.
Show resolved Hide resolved

https://guides.micronaut.io/latest/tag-open_api.html
2 changes: 2 additions & 0 deletions src/main/docs/guide/openApiViews/swaggerui.adoc
View file
Open in desktop
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.
sdelamo marked this conversation as resolved.
Show resolved Hide resolved
sdelamo marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions src/main/docs/guide/toc.yml
View file
Open in desktop
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
Loading