Class SwaggerUtil

constructor

• new SwaggerUtil(): SwaggerUtil

  Returns SwaggerUtil

Staticlogger

StaticgetLogger

• getLogger(): CoreLogChannel

  Returns CoreLogChannel

Staticmerge

• merge(root: SwaggerConfig, data: MergeInputType[]): SwaggerConfig

  Parameters

  • root: SwaggerConfig
  • data: MergeInputType[]

  Returns SwaggerConfig

StaticmergeConfig

• mergeConfig(root: SwaggerConfig, data: SwaggerConfig[]): SwaggerConfig

  Parameters

  • root: SwaggerConfig
  • data: SwaggerConfig[]

  Returns SwaggerConfig

StaticmetaExtractor

• metaExtractor(
      root: Object,
      npmPackageVersion: boolean,
      ...path: Object[],
  ): SwaggerConfig | undefined

  Parameters

  • root: Object
  • npmPackageVersion: boolean
  • ...path: Object[]

  Returns SwaggerConfig | undefined

StaticreadMeta

• readMeta(path: string): any

  Parameters

  • path: string

  Returns any

StaticrouteToSwaggerPath

• routeToSwaggerPath(route: RouteData): SwaggerRPath

  Parameters

  • route: RouteData

  Returns SwaggerRPath

StaticserveMeta

• serveMeta(
      conf: SwaggerConfig,
      option?: { auth?: string; port?: number; type?: "swagger-ui" | "scalar" },
  ): Promise<Server | null>

  Serves a meta page for Swagger UI or rapi-doc.

  Parameters

  • conf: SwaggerConfig

    The swagger configuration to expose via /spec.

  • Optionaloption: { auth?: string; port?: number; type?: "swagger-ui" | "scalar" }

    Options for serving the meta page.

    • Optionalauth?: string

      Optional authentication key appended to the URL.

    • Optionalport?: number

      The port to listen on. Defaults to 9000.

    • Optionaltype?: "swagger-ui" | "scalar"

      The type of UI to serve.

  Returns Promise<Server | null>

  A promise that resolves with the created server instance or null.

StaticwriteMeta

• writeMeta(conf: SwaggerConfig, kind: "JSON" | "YAML", path?: string): void

  Parameters

  • conf: SwaggerConfig
  • kind: "JSON" | "YAML"
  • Optionalpath: string

  Returns void