Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DocSwagger

Export swagger document

- DocSwagger:
   saveTo: test.swagger.yaml         # Swagger ouput file
   headers: []                       # Only expose these request headers
   responseHeaders: ["content-type"] # Only expose these response headers
   raw:                              # Overide OpenAPI properties
     components:
       securitySchemes:
         bearerAuth:
           type: http
           scheme: bearer
           bearerFormat: JWT
         bypassAuth:
           type: apiKey
           name: keyHere
           description: ...
           in: header
         bypassAuthHeader:
           type: apiKey
           name: valueHere
           description: ...
           in: header

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

async

async: boolean

Run async

content

content: string

String data content

disabled

disabled: boolean

Ignore this, not run

headers

headers: string[]

Only doc these request headers

ignoreError

ignoreError: boolean

Keep run the next when got error

raw

raw: OpenAPI

Overide OpenAPI properties which system generated

responseHeaders

responseHeaders: string[]

Only doc these response headers

saveTo

saveTo: string

Output file to save

slient

slient: boolean

Not show log

testIt

testIt: boolean

Only allow run it then ignore others which not set testIt or set it to false

title

title: string

Step title

vars

vars: any

Declare global variable