Articles → AWS → Documentation In The AWS API Gateway

Documentation In The AWS API Gateway

In this article, we will create the documentation in the AWS API gateway.

Create A New API

First, create a new API gateway and add a Get method inside it.

Picture showing the GET method in the API Gateway service

Click to Enlarge

Documentation

On the left-hand side of the screen, there is a menu Documentation.

Click to Enlarge

A screen appears on the right-hand side. Click on the Create Documentation Part button.

Picture showing a screen to add the documentation part

Click to Enlarge

A section will appear where you can specify the Type, Path and the Method.

Picture showing adding a documentation part

Click to Enlarge

Once you click on the Save button the documentation part is added for the API.

Picture showing adding the documentation part in API gateway

Click to Enlarge

On the top right side, there is a button Import Documentation. You can import the documentation from here.

Export Documentation

You can export the documentation as well. For that, deploy the API. On the Export tab, you have the option to export the documentation in different formats.

Picture showing the screen to export the documentation

Click to Enlarge

Posted By -	Karan Gupta

Posted On -	Thursday, May 25, 2023

Query/Feedback

Your Email Id		**

Subject		*

Query/Feedback	Characters remaining 250	**