How to generate swagger documentation for aws-lambda python API?

Question

I have an AWS-lambda based API, written in python. The data is in elastic search. The python code is basically an interface between the user and ES.

I need to add swagger documentation.

I can create the swagger.json file manually, but I would like to have some automated process, to be able to keep up with future changes.

Is there a library that would help me to somehow automatically generate the swagger documentation?

I was searching around, and I found multiple libraries for flask, but I'm not using flask

You can create API endpoint and deploy. After deploy API endpoint you will get option to download Swagger file — Avinash Dalvi, Oct 15 '20 at 20:19

score 4 · Answer 1 · answered Oct 16 '20 at 18:09

4

Steps to get swagger details from AWS API gateway :

Go to API gateway
Click on stage
Select Stage which you need to get
Select "Export" tab
Choose required option like Export as Swagger

answered Oct 16 '20 at 18:09

Avinash Dalvi

8,551
7
27
53

Thanks. The problem is that I'm doing the development locally. I have a local SAM environment that simulates API gateway for me. – eternal_student Oct 16 '20 at 21:36
Ok. If this help you don’t forget to upvote and accept as answer. – Avinash Dalvi Oct 16 '20 at 21:37
Is it possible to do it locally? – eternal_student Oct 19 '20 at 15:12

score 3 · Answer 2 · answered Jul 27 '21 at 00:58

In API Gateway you can create REST APIs or HTTP APIs, for the differences see here.

@aviboy2006's answer is for the older standard, REST API.

If you are using the newer HTTP API, you can only export in OpenAPI 3.0 format (Swagger will import this, unless you have an old version) and you have to export using the AWS CLI:

aws apigatewayv2 export-api \
    --api-id api-id  \
    --output-type YAML  \
    --specification OAS30 \
    --stage-name prod \
    stage-definition.yaml

for output type you can choose between JSON and YAML.

Source: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-export.html

How to generate swagger documentation for aws-lambda python API?

2 Answers2