Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GenerateSwaggerV2DocumentOptions

Options for 'generateSwaggerV2Doc()' function.

Hierarchy

  • GenerateSwaggerV2DocumentOptions

Index

Properties

Properties

Optional basePath

basePath: string

The base path of the API.

Optional externalDocs

externalDocs: SwaggerV2DocumentExternalDocs

External docs.

Optional host

host: string

The host name.

Optional info

info: SwaggerV2DocumentInfo

Information about the document.

Optional schemes

schemes: ApiUrlScheme | ApiUrlScheme[]

The list of possible schemes.

Optional securityDefinitions

securityDefinitions: SwaggerV2SecurityDefintionList

Security definitions.

Optional tags

tags: object

List of tags (key => name; value => description).

Type declaration

  • [name: string]: string

Generated using TypeDoc