Skip to main content

@backstage/backend-openapi-utils

Home > @backstage/backend-openapi-utils

Common functionalities for the openapi-router plugin.

Functions

FunctionDescription
createValidatedOpenApiRouter(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.

Interfaces

InterfaceDescription
ApiRouterTyped Express router based on an OpenAPI 3.1 spec.

Namespaces

NamespaceDescription
internal

Variables

VariableDescription
wrapInOpenApiTestServer!!! 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.

Type Aliases

Type AliasDescription
CookieParameters
HeaderParameters
PathParameters
QueryParameters
Request_2
Response_2