Publish API documentation using the API Gateway console - Amazon API Gateway
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

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. To learn more, see Export a REST API from API Gateway.