SwaggerOptions

see https://swagger.io/specification/

Index

Properties

• auth
• contact
• description
• displayOptions
• documentOptions
• externalDocs
• isGenerateTagForController
• license
• routerFilter
• servers
• swaggerPath
• swaggerUIRender
• swaggerUIRenderOptions
• tagSortable
• tags
• termsOfService
• title
• version

Properties

optionalauth

auth?: AuthOptions | AuthOptions[]

可以参考 https://swagger.io/specification/#security-scheme-object

optionalcontact

contact?: ContactObject

https://swagger.io/specification/#info-object contact 字段

optionaldescription

description?: string

默认值: This is a swagger-ui for midwayjs project https://swagger.io/specification/#info-object description 字段

optionaldisplayOptions

displayOptions?: { deepLinking?: boolean; defaultModelExpandDepth?: number; defaultModelRendering?: example | model; defaultModelsExpandDepth?: number; displayOperationId?: boolean; displayRequestDuration?: boolean; docExpansion?: list | none | full; filter?: string | boolean; maxDisplayedTags?: number; showCommonExtensions?: boolean; showExtensions?: boolean; tryItOutEnabled?: boolean; useUnsafeMarkdown?: boolean }

UI 展示中需要用到的配置 可以参考 https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#display

optionaldocumentOptions

documentOptions?: { operationIdFactory?: (controllerKey: string, webRouter: RouterOption) => string }

optionalexternalDocs

externalDocs?: ExternalDocumentationObject

https://swagger.io/specification/#openapi-object externalDocs 字段

optionalisGenerateTagForController

isGenerateTagForController?: boolean

Weather to generate the Tag for controller

optionallicense

license?: LicenseObject

https://swagger.io/specification/#info-object license 字段

optionalrouterFilter

routerFilter?: (url: string, options: RouterOption) => boolean

optionalservers

servers?: ServerObject[]

https://swagger.io/specification/#openapi-object servers 字段

optionalswaggerPath

swaggerPath?: string

默认值: /swagger-ui 访问 swagger ui 的路径

optionalswaggerUIRender

swaggerUIRender?: (config: SwaggerOptions, swaggerExplorer: SwaggerExplorer) => (pathname: string) => Promise<{ content: any; ext: string }>

optionalswaggerUIRenderOptions

swaggerUIRenderOptions?: Record<string, any>

optionaltagSortable

tagSortable?: boolean

对路由 tag 进行 ascii 排序 可以使用 1-xxx、2-xxx、3-xxx 来定义 tag

optionaltags

tags?: TagObject[]

https://swagger.io/specification/#openapi-object tags 字段

optionaltermsOfService

termsOfService?: string

https://swagger.io/specification/#info-object termsOfService 字段

optionaltitle

title?: string

默认值: My Project https://swagger.io/specification/#info-object title 字段

optionalversion

version?: string

默认值: 1.0.0 https://swagger.io/specification/#info-object version 字段