OpenAPI management
A module to provide an OpenAPI file from an application, as well as Swagger UI and Rapidoc for displaying OpenAPI.
Dependency¶
Dependency build.gradle
:
Module:
Dependency build.gradle.kts
:
Module:
Requires HTTP server module.
Configuration¶
An example of the configuration described in the OpenApiManagementConfig
class:
Recommendations¶
Tip
We recommend using contract first approach and generate code using this contract, in this approach same contract file is displayed.
In the case where the code is first and the contract file is supposed to be created from it, you can use the Swagger Gradle Plugin. together with Swagger annotation set, which will be used to create the contract file.