AuthOptions

继承自 https://swagger.io/specification/#security-scheme-object

Hierarchy

• Omit<SecuritySchemeObject, type>
  • AuthOptions

Index

Properties

• authType
• bearerFormat
• cookieName
• description
• flows
• in
• name
• openIdConnectUrl
• scheme
• securityName
• type

Properties

authType

authType: AuthType

验权类型 basic =&gt; http basic 验证 bearer =&gt; http jwt 验证 cookie =&gt; cookie 方式验证 oauth2 =&gt; 使用 oauth2 apikey =&gt; apiKey custom =&gt; 自定义方式

optionalbearerFormat

bearerFormat?: string

Inherited from Omit.bearerFormat

optionalcookieName

cookieName?: string

authType = cookie 时可以修改，cookie 的名称

optionaldescription

description?: string

Inherited from Omit.description

optionalflows

flows?: OAuthFlowsObject

Inherited from Omit.flows

optionalin

in?: string

Inherited from Omit.in

optionalname

name?: string

Inherited from Omit.name

optionalopenIdConnectUrl

openIdConnectUrl?: string

Inherited from Omit.openIdConnectUrl

optionalscheme

scheme?: string

Inherited from Omit.scheme

optionalsecurityName

securityName?: string

authType = cookie 时可以修改，通过 ApiCookie 装饰器关联的名称

optionaltype

type?: SecuritySchemeType

https://swagger.io/specification/#security-scheme-object type 字段