OpenApi3
class OpenApi3<NODE : Any>(apiInfo: ApiInfo, json: Json<NODE>, extensions: List<OpenApiExtension> = emptyList(), apiRenderer: ApiRenderer<Api<NODE>, NODE> = OpenApi3ApiRenderer(json), securityRenderer: SecurityRenderer = OpenApi3SecurityRenderer, errorResponseRenderer: ErrorResponseRenderer = JsonErrorResponseRenderer(json), servers: List<ApiServer> = emptyList(), version: OpenApiVersion = _3_0_0) : ContractRenderer, ErrorResponseRenderer
Contract renderer for OpenApi3 format JSON. For the JSON schema generation, naming of object models will default to either reflective or hashcode based depending on if a Auto Json is passed.
Constructors
Link copied to clipboard
constructor(apiInfo: ApiInfo, json: AutoMarshallingJson<NODE>, extensions: List<OpenApiExtension> = emptyList(), servers: List<ApiServer> = emptyList(), version: OpenApiVersion = _3_0_0)
constructor(apiInfo: ApiInfo, json: Json<NODE>, extensions: List<OpenApiExtension> = emptyList(), apiRenderer: ApiRenderer<Api<NODE>, NODE> = OpenApi3ApiRenderer(json), securityRenderer: SecurityRenderer = OpenApi3SecurityRenderer, errorResponseRenderer: ErrorResponseRenderer = JsonErrorResponseRenderer(json), servers: List<ApiServer> = emptyList(), version: OpenApiVersion = _3_0_0)
Functions
Link copied to clipboard
Link copied to clipboard
open override fun description(contractRoot: PathSegments, security: Security?, routes: List<ContractRoute>, tags: Set<Tag>, webhooks: Map<String, List<WebCallback>>): Response