Logo Questions Linux Laravel Mysql Ubuntu Git Menu
HTML CSS JAVASCRIPT SQL PYTHON PHP BOOTSTRAP JAVA JQUERY R React Kotlin
 

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

Tags:

python

aws-lambda

swagger-ui

openapi

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

like image 459
eternal_student Avatar asked Oct 15 '20 18:10

eternal_student

People also ask

How do I create a Swagger API document?

Head over to Swagger Inspector, and insert the end point of the resource you want to have documented. You can then navigate to the right panel from the History section of Swagger Inspector, and click "Create API definition" to create the OAS definition.

Can Swagger documentation be used for AWS API gateway setup?

It is a fully managed platform which allows users to build, deploy and manage APIs at any scale. The important aspect of the Amazon API Gateway is that it supports the Swagger definition format for designing and building RESTful APIs, and as you know, SwaggerHub is all about the Swagger!

1 Answers

Steps to get swagger details from AWS API gateway :

  1. Go to API gateway
  2. Click on stage
  3. Select Stage which you need to get
  4. Select "Export" tab
  5. Choose required option like Export as Swagger

Swagger export images

like image 89
aviboy2006 Avatar answered Oct 08 '22 08:10

aviboy2006
Sign in to Comment

Related questions

How to deal with name clash collections.Counter and typing.Counter?
Ubuntu 20.04 "Temporary failure in name resolution" - recently reinstalled
GSDMM Convergence of Clusters (Short Text Clustering)
Python logging why outputing twice?
pandas dataframe column based on previous rows
How to run a Django project with .pyc files without using source codes?
How to display hover info on a plotly Table?
Problem with creating an environment from .yml file, error "CondaEnvException: Pip failed" raised
NumPy: Alternative to `vectorize` that lets me access the array
unable to access environment variables from docker compose env file
Unit Test Retry functionality provided by Python
How to create a vertical scroll bar with Plotly?
Repeat value every 4 rows and use the beginning rows to fill the rest
Why is the scientific formatting of Decimal(0) different from float 0?
Adding items to Wishlist | Django
How to annotate difference between bars?
How to convert a function in a third party library to be async?
Python macOS builds run from Terminal but crash on Finder launch
Training MSE loss larger than theoretical maximum?
Why does client.recv(1024) return an empty byte literal in this bare-bones WebSocket Server implementation?

Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!