apig-swagger-ui (for AWS)

This command line tool generates a static Swagger UI website that incorporates the API specifications of your AWS API Gateway APIs. The generated website files are stored locally on your file system, and if desired, the tool can also launch a local server for convenient previewing.

Only APIs that have been mapped to custom domains will be included in the generated website.

Prior to using this tool, please ensure that you are logged into your AWS account using a suitable command line tool like aws, saml2aws, okta-aws, or similar.

Please note that this tool is not provided or endorsed by AWS, and if you want it to utilise your AWS credentials and configurations stored under ~/.aws, you will need to explictly grant it the permission to do so either through GUI or sudo snap connect apig-swagger-ui:dot-aws-config-credentials.

Quick start

Try something like this:

 $ apig-swagger-ui -r ap-southeast-2  -s

 Generating OpenAPI spec for: https://tools-prod.example.com/

 Generating OpenAPI spec for: https://tools-staging.example.com/

 Generating OpenAPI spec for: https://api.example.com/

 Local server started. Ctrl-C to stop. Access URL: http://localhost:8001/

For more information and detailed instructions, you can visit the GitHub repository at: https://github.com/james-hu/apig-swagger-ui