kevwo / flask-restful-swagger

A Swagger spec extractor for flask-restful

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

flask-restful-swagger

This fork adds the following functionality. (Forked from https://github.com/rantav/flask-restful-swagger)

1.) Ability to group sections of swagger APIs.

@swagger.resource(
    hierarchy_id='VendingMachines',
    hierarchy_description='Operations on VendingMachines objects'
)
class VendingMachine(Resource):

2.) Ability to specify a custom description for a swagger URL.

api.add_resource(VendingMachine, "/Region/<string:region_id>"
                                    "/Brand/<string:brand_id>"
                                    "/Machine/<string:machine_id>", display_path="/**/machine")

3.) Removed some of the unused icons from the swagger page.

Install:

pip install git+git://github.com/kevwo/flask-restful-swagger.git#egg=flask-restful-swagger

(This installs flask-restful as well)

About

A Swagger spec extractor for flask-restful

License:MIT License


Languages

Language:JavaScript 88.8%Language:CSS 8.3%Language:Python 2.1%Language:HTML 0.8%Language:Makefile 0.0%