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
Thank you for your report. Information you provided will help us investigate further.
There was an error while sending your report. Please try again later.
You are about to open
Do you wish to proceed?
Snaps are applications packaged with all their dependencies to run on all popular Linux distributions from a single build. They update automatically and roll back gracefully.
Snaps are discoverable and installable from the Snap Store, an app store with an audience of millions.
If you’re running Kubuntu 16.04 LTS (Xenial Xerus) or later, including Kubuntu 18.04 LTS (Bionic Beaver) and Kubuntu 18.10 (Cosmic Cuttlefish), you don’t need to do anything. Snap is already installed and ready to go.
Versions of Kubuntu between 14.04 LTS (Trusty Tahr) and 15.10 (Wily Werewolf) don’t include snap by default, but snap can be installed from the command line as follows:
sudo apt update
sudo apt install snapd
To install apig-swagger-ui (for AWS), simply use the following command:
sudo snap install apig-swagger-ui
Browse and find snaps from the convenience of your desktop using the snap store snap.
Interested to find out more about snaps? Want to publish your own application? Visit snapcraft.io now.
