thiyagaraj / sphinxcontrib-openapi

OpenAPI (fka Swagger) spec renderer for Sphinx.

sphinxcontrib-openapi

sphinxcontrib-openapi is a Sphinx extension to generate APIs docs from OpenAPI (fka Swagger) spec. It depends on sphinxcontrib-httpdomain that provides an HTTP domain for describing RESTful HTTP APIs, so we don't need to reinvent the wheel.

pip install sphinxcontrib-openapi

Usage

Pass sphinxcontrib-openapi to extensions list in Sphinx's conf.py

extensions = [
   ...
   'sphinxcontrib-openapi',
]

and feel free to use the openapi directive to render OpenAPI specs

.. openapi:: path/to/openapi.yml

Links

• Documentation: https://sphinxcontrib-openapi.readthedocs.org/
• Source: https://github.com/ikalnitsky/sphinxcontrib-openapi
• Bugs: https://github.com/ikalnitsky/sphinxcontrib-openapi/issues