Metadata-Version: 2.1
Name: Flask-Docs-Api
Version: 1.1.1.2
Summary: Easy Docs for flask
Home-page: http://github.com/lwerner-lshigh/flask-api/
Author: Lukas Werner
Author-email: lwerner@lshigh.org
License: MIT
Description: # Flask-Docs-Api
        [Flask-Docs-Api | PyPI](https://pypi.org/project/Flask-Docs-Api)
        
        A library to make doc generation painless
        
        ### Installation
        
        ```bash
        pip install Flask-Docs-Api
        ```
        
        
        ### Sample Usage (copy & paste)
        
        ```python
        from flask_api_docs.api import Api
        api = Api(app, "Test")
        api.route("/docs")
        ```
        Sample
        
        ![](https://raw.githubusercontent.com/lwerner-lshigh/Flask-Api/master/sample.png)
        
        
        ### How it works
        Flask-Docs-Api uses the docstrings of your existing python code and the methods defined in your routes to generate the api docs.
        
        
        ### Api of Flask-Docs-Api
        
        Api class 
        
        Constructor: Requires the app, and an optional name for the api docs title.
        
        route: takes a url for the api doc route
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
