papsign / Ktor-OpenAPI-Generator

Ktor OpenAPI/Swagger 3 Generator
Apache License 2.0
241 stars 42 forks source link

Support model property descriptions #53

Closed bherbst closed 4 years ago

bherbst commented 4 years ago

This PR adds support for annotating model properties to provide a description (see #52).

Sample usage:

@Response("A String Response")
data class StringResponse(
    @Description("The string value") val str: String
)

Generated Swagger JSON:

 "StringResponse" : {
        "nullable" : false,
        "properties" : {
          "str" : {
            "description" : "The string value",
            "nullable" : false,
            "type" : "string"
          }
        },
        "required" : [ "str" ],
        "type" : "object"
      }

Swagger UI:

Screen Shot 2020-05-21 at 1 31 23 PM