isabinin / aws-apigateway-swagger-exporter

Tool for exporting API specification from existing AWS API Gateway APIs in a Swagger fromat

Amazon API Gateway Swagger Exporter

The Amazon API Gateway Swagger Exporter lets you export API specification from existing Amazon API Gateway APIs in a Swagger API representation.

This tool was inspired by Amazon API Gateway Importer

Usage

Prerequisites

This tool requires the AWS CLI. Download and configure following instructions to set up your system for accessing your AWS account.

Alternatevly, you can use environment variables to provide AWS access credentials and AWS region. Environment variables override AWS CLI configuration and can be useful for scripting. The following variables are supported: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_DEFAULT_REGION.

Build with mvn assembly:assembly

Export an existing API in Swagger YAML format, output to console

./aws-api-export.sh --api API_ID

Export an existing API in Swagger JSON format, save to a file

./aws-api-export.sh --api API_ID --format json --output FILENAME.json

Describe all CLI parameters

./aws-api-exporter.sh

For Windows environments replace ./aws-api-export.sh with ./aws-api-export.cmd in the examples.