Class: BaseOpenAPIRoute

Defined in: service-core/src/routes/BaseOpenAPIRoute.ts:60

The BaseOpenAPIRoute class provides a base set of endpoints exposing the server's OpenAPI specification.

Exposed endpoints:

Name	HTTP Method	What it does
getHTML	GET /<base_path>	Swagger UI HTML (loads swagger-ui-dist from CDN)
getJSON	GET /<base_path>/json	raw OpenAPI specification as JSON
getYAML	GET /<base_path>/yaml	raw OpenAPI specification as YAML

!!Note!! that the BaseAdminRoute is not automatically registered with a server by default. You must create your own class that extends AdminRoute and apply the desired base path with @Route().

Example

import { BaseOpenAPIRoute, RouteDecorators } from "@rapidrest/service-core";
const { Route } = RouteDecorators;

@Route("/openapi")
export class OpenAPIRoute extends BaseOpenAPIRoute {}

Constructors

Constructor

new BaseOpenAPIRoute(): BaseOpenAPIRoute

Returns

BaseOpenAPIRoute

Properties

apiSpec

protected apiSpec: OpenApiSpec

Defined in: service-core/src/routes/BaseOpenAPIRoute.ts:63

The underlying OpenAPI specification.

Methods

getHTML()

getHTML(): string

Defined in: service-core/src/routes/BaseOpenAPIRoute.ts:70

Returns

string

---

getJSON()

getJSON(): any

Defined in: service-core/src/routes/BaseOpenAPIRoute.ts:78

Returns

any

---

getYAML()

getYAML(): string

Defined in: service-core/src/routes/BaseOpenAPIRoute.ts:87

Returns

string