aws-apigateway-swagger-importer
A tool to create or update Amazon API Gateway APIs from Swagger or RAML definitions.
What is aws-apigateway-swagger-importer?
Amazon API Gateway Importer is a command-line tool that allows developers to create and update APIs on Amazon API Gateway using Swagger or RAML API definition files. It automates the process of importing API specifications into AWS, enabling infrastructure-as-code workflows for API management. The tool was particularly useful before AWS natively supported Swagger import in its standard tools.
Developers and DevOps engineers working with Amazon API Gateway who need to manage APIs programmatically using Swagger or RAML definitions, especially those using RAML which lacks native AWS support.
It provides a scriptable way to import and update API Gateway configurations, supporting both Swagger and RAML formats with AWS-specific extensions. While AWS now offers native Swagger import, this tool remains valuable for RAML users and those who prefer a standalone CLI workflow.
Overview
Tools to work with Amazon API Gateway, Swagger, and RAML
Use Cases
Best For
- Importing Swagger definitions into Amazon API Gateway via CLI
- Managing API Gateway APIs using RAML specifications
- Automating API deployment and updates in CI/CD pipelines
- Using API Gateway extensions for auth and integration configuration
- Scripting infrastructure-as-code for AWS API management
- Updating existing APIs and deploying to stages in one command
Not Ideal For
- Teams requiring official AWS support and regular updates for API Gateway management
- Projects exclusively using Swagger/OpenAPI definitions without RAML components
- New AWS customers leveraging post-2016 API Gateway features like HTTP APIs or WebSocket support
- Organizations with strict compliance needs mandating vendor-maintained, fully supported tools
Pros & Cons
Pros
Provides import functionality for RAML API definitions, which AWS's native tools do not support, as explicitly noted in the README's updates section.
Enables scriptable API creation and updates with single commands, ideal for CI/CD pipelines, such as updating and deploying to a stage in one step.
Fully supports API Gateway-specific extensions like x-amazon-apigateway-auth and x-amazon-apigateway-integration, allowing detailed configuration directly in definition files.
Maintains a standalone workflow for teams accustomed to pre-2016 AWS tooling, avoiding immediate migration overhead for existing setups.
Cons
The README states the tool receives minimal support from AWS and encourages migration to official tools, risking bugs and compatibility issues with newer AWS services.
Requires building from source with Maven, adding setup steps compared to pre-packaged AWS CLI or SDKs that are easier to install and use.
Likely lacks support for newer API Gateway features introduced after 2016, and for Swagger users, it's redundant since AWS now offers native import.
Frequently Asked Questions
Related Projects
api-gateway-secure-pet-storeAmazon API Gateway sample using Amazon Cognito credentials through AWS Lambda
aws-apigateway-sdk-javaThis repository contains the AWS API Gateway SDK for Java, which has been archived and is now read-only. The SDK was designed to help Java developers interact with AWS API Gateway services, but is no longer actively maintained. ## Key Features - **AWS API Gateway Integration** — SDK for connecting Java applications to AWS API Gateway - **Java Development** — Tools and libraries specifically for Java developers working with AWS services - **Archived Codebase** — Repository preserved in read-only state with all existing functionality maintained ## Philosophy The project followed AWS's approach to providing language-specific SDKs for their cloud services, though it has since been archived as part of AWS's SDK consolidation efforts.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.