https://github.com/viniciuschiele/flask-apidoc

Adds ApiDoc support to Flask
https://github.com/viniciuschiele/flask-apidoc

apidoc apidocs docs documentation flask flask-extensions python

Last synced: 2 months ago
JSON representation

Adds ApiDoc support to Flask

• Host: GitHub
• URL: https://github.com/viniciuschiele/flask-apidoc
• Owner: viniciuschiele
• License: mit
• Created: 2015-06-17T09:27:17.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-11-27T15:45:50.000Z (about 3 years ago)
• Last Synced: 2024-10-31T12:46:41.377Z (2 months ago)
• Topics: apidoc, apidocs, docs, documentation, flask, flask-extensions, python
• Language: Python
• Homepage:
• Size: 34.2 KB
• Stars: 55
• Watchers: 3
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=================================

Flask ApiDoc

=================================

Flask ApiDoc is a Flask extension which adds support for the ApiDoc_.

|Version|

Features

===============

- click command to generate the apidoc's files, by default they are generated into static/docs

- Host apidoc's files, by default they are hosted in http://localhost:5000/docs

- Replace the base URL for the endpoints by the current Flask URL.

- Allow absolute urls in @api

Documentation

===============

Soon... take a look at the example_ to see how it works.

Installation

===============

You can install flask-apidoc via Python Package Index (PyPI_),::

    $ pip install flask-apidoc

Feedback

===============

Please use the Issues_ for feature requests and troubleshooting usage.

.. |Version| image:: https://badge.fury.io/py/flask-apidoc.svg

   :target: http://badge.fury.io/py/flask-apidoc

.. _ApiDoc: http://www.apidocjs.com

.. _example: https://github.com/viniciuschiele/flask-apidoc/tree/master/example

.. _PyPi: https://pypi.python.org/pypi/flask-apidoc

.. _Issues: https://github.com/viniciuschiele/flask-apidoc/issues