@backstage/backend-openapi-utils
Home > @backstage/backend-openapi-utils
Common functionalities for the openapi-router plugin.
Functions
Function |
Description |
---|---|
Create a new OpenAPI router with some default middleware. | |
createValidatedOpenApiRouterFromGeneratedEndpointMap(spec, options) |
Create a new OpenAPI router with some default middleware. |
Given a base url for a plugin, find the given OpenAPI spec for that plugin. | |
!!! 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 | |
!!! 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 |
---|---|
Typed Express router based on an OpenAPI 3.1 spec. |
Namespaces
Namespace |
Description |
---|---|
Type Aliases
Type Alias |
Description |
---|---|
Validate a string against OpenAPI path template, https://spec.openapis.org/oas/v3.1.0#path-templating-matching. | |