Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: Ingest OpenAPI specifications from Amazon API Gateway #66

Open
niallthomson opened this issue Apr 10, 2024 · 0 comments
Open
Labels
enhancement New feature or request

Comments

@niallthomson
Copy link
Contributor

🔖 Feature description

Using Backstage as an API catalog is a common use-case with its support for OpenAPI specifications. Today users will tend to "manually" sync the OpenAPI specification to Backstage through something like a build/deployment tool.

This feature would allow Backstage users to "automatically" sync OpenAPI specifications directly from Amazon API Gateway, removing the need for separate process.

🎤 Context

See here for similar solution from AWS partner ReadMe

https://aws.amazon.com/blogs/apn/integrating-readme-with-amazon-api-gateway-to-keep-your-developer-hub-up-to-date/

Use-case:

https://aws.amazon.com/blogs/opensource/how-traveloka-uses-backstage-as-an-api-developer-portal-for-amazon-api-gateway/

API call to export OpenAPI specification:

https://docs.aws.amazon.com/apigateway/latest/api/API_GetExport.html

✌️ Possible Implementation

No response

@niallthomson niallthomson added the enhancement New feature or request label Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant