Amazon API Gateway
Developer Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Publish API Documentation Using the API Gateway Console

The following procedure describes how to publish a documentation version.

To publish a documentation version using the API Gateway console

  1. Choose Documentation for the API from the main navigation pane in the API Gateway console.

  2. Choose Publish Documentation in the Documentation pane.

  3. Set up the publication:

    1. Choose an available name for Stage.

    2. Type a version identifier, e.g., 1.0.0, in Version.

    3. Optionally, provide a description about the publication in Description.

  4. Choose Publish.

You can now proceed to download the published documentation by exporting the documentation to an external OpenAPI file.