Publish API documentation using the API Gateway console - Amazon API Gateway

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. In the main navigation pane, choose Documentation.

  2. Choose Publish documentation.

  3. Set up the publication:

    1. For Stage, select a stage.

    2. For Version, enter a version identifier, e.g., 1.0.0.

    3. (Optional) For Description, enter a 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.