Skip to main content

Package used to create flask swagger documentation in few minutes with least possible effort.

Project description

Logo

Easy Flask Swagger

Easy Flask Swagger - Creating flask swagger documentation in few minutes with least possible effort.

Installation

Using PIP

  pip install easy-flask-swagger

Usage/Examples

from easy_flask_swagger import EasyFlaskSwagger
efs = EasyFlaskSwagger("My Backend Documentation")
efs.setPaths({SwaggerTags.AUTHENTICATION: [signup]})
efs.setSchemas([User])
efs.setDescriptions({
  SwaggerTags.AUTHENTICATION: 'For user authentication'
})
pprint(efs.to_dict())
# And that's it 😁

Run Locally

Clone the project

  git clone https://github.com/YashMakan/easy-flask-swagger

Go to the project directory

  cd my-project

Install dependencies

  pip install -r requirements.txt

Run the tests/test.py file

  python tests/test.py

Authors

MIT License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

easy_flask_swagger-1.0.0-py3-none-any.whl (2.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page