-
Notifications
You must be signed in to change notification settings - Fork 7.4k
OpenAPI spec for the REST API #2566
Copy link
Copy link
Closed
Labels
area:openapi-toolingRelated to the OpenAPI Tooling Project AreaRelated to the OpenAPI Tooling Project Areapriority:contrib-neededHelp/Contributions wanted from community membersHelp/Contributions wanted from community memberstype:suggestionNew feature or requestNew feature or request
Description
Metadata
Metadata
Assignees
Labels
area:openapi-toolingRelated to the OpenAPI Tooling Project AreaRelated to the OpenAPI Tooling Project Areapriority:contrib-neededHelp/Contributions wanted from community membersHelp/Contributions wanted from community memberstype:suggestionNew feature or requestNew feature or request
Type
Fields
Give feedbackNo fields configured for issues without a type.
Context
An organization that I'm working with is considering adopting Backstage as their developer portal. One of the hard(ish) requirements that they have is that all services that we consume provide an API specification. This requirement exists because the infrastructure team needs to automate communication with services. If a specification is available, then they can use code generators to generate API clients for these services.
Feature Suggestion
It would be very helpful if there was a way to ensure that services integrated into Backstage come automatically with specifications. .NET, Rails & FastAPI all provide a mechanism that automatically generates an OpenAPI definition from route definition. I'm not aware of any tools that work like this in Node.js world.
Possible Implementation
express-openapi is a middleware that generates some specification from routes. It doesn't produce complete specifications - I don't even know if this is possible.
This request could also be satisfied by a GraphQL API that wraps services that Backstages consumes. The only consideration is making sure that the design of the APIs covers plugin services as much as possible.