flask-restless-swagger-2
Magically create Swagger documentation as you magically create your RESTful API with Flask-Restless
This has lingered a while without the love it needs due to other more pressing projects. Contributions are welcome and appreciated.
This is my fork of [flask-restless-swagger](https://github.com/mmessmore/flask-restless-swagger). It had several bugs and also lackluster doc. To install:
pip install flask-restless-swagger-2
To use import like so
from flask_restless_swagger import SwagAPIManager as APIManager
Using this, you replace your current flask-restless APIManager usage with the swagg’d one
Run your flask app, and then go to [localhost:5000/swagger](localhost:5000/swagger)
You can see the generated swagger json in [localhost:5000/swagger.json](localhost:5000/swagger.json)
Features
This strives to be a drop in replacement for Flask-Restless’ APIManager. It wraps the APIManager calls to try to gather enough information to present a Swagger 2.0 file. It also deploys the static content for the Swagger-UI configured to point to said Swagger JSON file.
Status
Currently it “works-for-me”. There are a few terrible assumptions it makes. It probably needs some more features to be usable for everyone. Suggestions, and pull requests are welcome.
TODO
Add Docstrings in Models as descriptions
Cleanup Markup
Make it suck less
Documentation
The full documentation is at http://flask-restless-swagger.rtfd.org.
History
0.1.0 (2015-07-15)
First release on PyPI.
1 maintainer
Release files for flask-restless-swagger-2 0.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| flask-restless-swagger-2-0.0.3.tar.gz | 1.0 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| flask_restless_swagger_2-0.0.3-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 2.1 MB
Release files / flask-restless-swagger-2-0.0.3.tar.gz
| Download URL | flask-restless-swagger-2-0.0.3.tar.gz |
|---|---|
| Size | 1.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
030ffd0cb27cc81398889f0f64c88b96111c6e5bb6ee3d3c7e5b616708757542
|
|
BLAKE2b-256 checksum How to use checksums |
c8b52c45848fc00bf55976ba34608de44eafd689fb90f84615869c1bd81993b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / flask_restless_swagger_2-0.0.3-py2.py3-none-any.whl
| Download URL | flask_restless_swagger_2-0.0.3-py2.py3-none-any.whl |
|---|---|
| Size | 1.1 MB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
e83d4840c8fe7a69489536748716f6971803a09fcfde1ec409b73efc0df5486d
|
|
BLAKE2b-256 checksum How to use checksums |
2f1dc7635f65311e41bddd8a9ceddfd63f62191c90d86e1e000856498deca568
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
