- Notifications
You must be signed in to change notification settings - Fork0
Olexandr88/ktor-docs-plugin
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This plugin implements a plug and play solution for generating OpenAPI (Swagger) specification for your Ktor server on any platform with minimal effort - no need to modify your existing code, no special DSL wrappers etc.Just annotate your route(s) definitions with@GenerateOpenApi andopenapi.yaml will be generated at build time.
Take a look at theSample Project to get started.
plugins { id("io.github.tabilzad.ktor-docs-plugin-gradle") version"0.6.2-alpha"}swagger { documentation { docsTitle="Ktor Server Title" docsDescription="Ktor Server Description" docsVersion="1.0" generateRequestSchemas=true hideTransientFields=true hidePrivateAndInternalFields=true deriveFieldRequirementFromTypeNullability=true } pluginOptions { format="yaml"// or json }}| Feature | isSupported | type |
|---|---|---|
| Path/Endpoint definitions | ✅ | Automatic |
| Ktor Resources | ✅ | Automatic |
| Request Schemas | ✅ | Automatic |
| Response Schemas | ✅ | Explicit |
| Endpoint/Scheme Descriptions | ✅ | Explicit |
| Endpoint Tagging | ✅ | Explicit |
| Option | Default Value | Explanation |
|---|---|---|
docsTitle | "Open API Specification" | Title for the API specification that is generated |
docsDescription | "Generated using Ktor Docs Plugin" | A brief description for the generated API specification |
docsVersion | "1.0.0" | Specifies the version for the generated API specification |
generateRequestSchemas | true | Determines if request body schemas should be automatically resolved and included |
hideTransientFields | true | Controls whether fields marked with@Transientare omitted in schema outputs |
hidePrivateAndInternalFields | true | Opts to exclude fields withprivate orinternal modifiers from schema outputs |
deriveFieldRequirementFromTypeNullability | true | Automatically derive object fields' requirement from its type nullability |
servers | empty | List of server URLs to be included in the spec (ex:listOf("http://localhost:8080") |
| Option | Default Value | Explanation |
|---|---|---|
enabled | true | Enable/Disables the plugin |
saveInBuild | true | Decides if the generated specification file should be saved in the build/ directory |
format | yaml | The chosen format for the OpenAPI specification (options: json/yaml) |
filePath | $modulePath/build/resources/main/openapi/ | The designated absolute path for saving the generated specification file |
Annotate the specific route definitions you want the OpenAPI specification to be generated for.
@GenerateOpenApifun Route.ordersRouting() { route("/v1") { post("/order1") {/*...*/ } }}
You could also annotate the entireApplication module with multiple/nested route definitions. The plugin willrecursively visit eachRoute. extension and generate its documentation.
@GenerateOpenApifun Application.ordersModule() { routing { routeOne() routeTwo() }}fun Route.routeOne() { route("/v1") {/*...*/ }}fun Route.routeTwo() { route("/v2") {/*...*/ } routeThree()}
Describe endpoints or schema fields.
data classRequestSample( @KtorFieldDescription("this is a string")valstring:String,valint:Int,valdouble:Double)@GenerateOpenApifun Route.ordersRouting() { route("/v1") { @KtorDescription( summary="Create Order", description="This endpoint will create an order", ) post("/create") { call.receive<RequestSample>() } route("/orders") { @KtorDescription( summary="All Orders", description="This endpoint will return a list of all orders" ) get {/*...*/ } } }}
Defining response schemas and their corresponding HTTP status codes are done via@KtorResponds annotation on an endpoint.
@GenerateOpenApifun Route.ordersRouting() { route("/v1") { @KtorResponds( [ResponseEntry("200",Order::class, description="Created order"),ResponseEntry("400",ErrorResponseSample::class, description="Invalid order payload") ] ) post("/create") {/*...*/ } @KtorResponds([ResponseEntry("200",Order::class, isCollection=true, description="All orders")]) get("/orders") {/*...*/ } }}
Using tags enables the categorization of individual endpoints into designated groups.Tags specified at the parent route will propogate down to all endpoints contained within it.
@Tag(["Orders"])fun Route.ordersRouting() { route("/v1") { post("/create") {/*...*/ } get("/orders") {/*...*/ } } route("/v2") { post("/create") {/*...*/ } get("/orders") {/*...*/ } }}
On the other hand, if the tags are specified with@KtorDescription or@Tag annotation on an endpoint, they are associated exclusively with that particular endpoint.
@GenerateOpenApifun Route.ordersRouting() { route("/v1") { @KtorDescription(tags= ["Order Operations"]) post("/order") {/*...*/ } @Tag(["Cart Operations"]) get("/cart") {/*...*/ } }}
- Automatic Response resolution
- Support for polymorphic types with discriminators
- Option for an automatic tag resolution from module/route function declaration
- Tag descriptions
- Parsing kdocs for schema/property descriptions
About
Provides Ktor Swagger support
Resources
Stars
Watchers
Forks
Packages0
Languages
- Kotlin100.0%