@backstage/backend-openapi-utils

Home > @backstage/backend-openapi-utils

Common functionalities for the openapi-router plugin.

Functions

Function	Description
createValidatedOpenApiRouter(spec, options)	Create a new OpenAPI router with some default middleware.
createValidatedOpenApiRouterFromGeneratedEndpointMap(spec, options)	Create a new OpenAPI router with some default middleware.
getOpenApiSpecRoute(baseUrl)	Given a base url for a plugin, find the given OpenAPI spec for that plugin.
wrapInOpenApiTestServer(app)	!!! THIS CURRENTLY ONLY SUPPORTS SUPERTEST !!! Running against supertest, we need some way to hit the optic proxy. This ensures that that happens at runtime when in the context of a yarn optic capture command.
wrapServer(app)	!!! THIS CURRENTLY ONLY SUPPORTS SUPERTEST !!! Setup a server with a custom OpenAPI proxy. This proxy will capture all requests and responses and make sure they conform to the spec.

Interfaces

Interface	Description
ApiRouter	Typed Express router based on an OpenAPI 3.1 spec.
TypedRouter

Namespaces

Namespace	Description
internal

Type Aliases

Type Alias	Description
CookieParameters
HeaderParameters
PathParameters
PathTemplate	Validate a string against OpenAPI path template, https://spec.openapis.org/oas/v3.1.0#path-templating-matching.
QueryParameters
Request_2
Response_2