https://github.com/riddhi89/simple-flask-project

Generate OpenAPI spec from Flask routes
https://github.com/riddhi89/simple-flask-project

flask openapi3 python3

Last synced: 3 months ago
JSON representation

Generate OpenAPI spec from Flask routes

• Host: GitHub
• URL: https://github.com/riddhi89/simple-flask-project
• Owner: riddhi89
• Created: 2018-06-25T00:08:10.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-06T01:50:05.000Z (over 6 years ago)
• Last Synced: 2024-05-28T04:08:54.843Z (5 months ago)
• Topics: flask, openapi3, python3
• Language: Python
• Size: 8.79 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - riddhi89/simple-flask-project - Generate OpenAPI spec from Flask routes (Python)

README

        
# simple-flask-project

Setup: create a python virtual environment and install the requirements:

	virtualenv --python=python3.6 .venv

	source .venv/bin/activate

	pip install -r requirements.txt

Generate OpenAPI spec from Flask routes:

	python generate_openapi_spec.py

    

View the OpenAPI spec using Swagger-UI:

    docker run --rm -p 9000:8080 --name swagger-ui -e SWAGGER_JSON=/api_docs/openapi.json -v $(PWD)/api_docs:/api_docs swaggerapi/swagger-ui