Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DocMarkdown

Export markdown document

- DocMarkdown:
    saveTo: test.md                       # Markdown ouput file
    headers: []                           # Only expose these request headers
    responseHeaders: ["content-type"]     # Only expose these response headers

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

Optional raw

raw: { description?: string; developer: string; servers: {}; title: string; version: string }

Overide swagger properties which system generated

Type declaration

  • Optional description?: string

    Document description

  • developer: string

    Developer

  • servers: {}

    Endpoints in service (production, staging, development)

    • [env: string]: string
  • title: string

    Document title

  • version: string

    Document version

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