https://github.com/sphinx-contrib/openapi

OpenAPI (fka Swagger) spec renderer for Sphinx.
https://github.com/sphinx-contrib/openapi

extension hacktoberfest oas openapi openapi2 openapi3 python sphinx sphinx-extension swagger

Last synced: 3 days ago
JSON representation

OpenAPI (fka Swagger) spec renderer for Sphinx.

• Host: GitHub
• URL: https://github.com/sphinx-contrib/openapi
• Owner: sphinx-contrib
• License: bsd-2-clause
• Created: 2016-09-23T06:28:32.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-11-21T14:57:43.000Z (about 2 months ago)
• Last Synced: 2025-01-05T13:09:54.527Z (6 days ago)
• Topics: extension, hacktoberfest, oas, openapi, openapi2, openapi3, python, sphinx, sphinx-extension, swagger
• Language: Python
• Homepage: https://sphinxcontrib-openapi.readthedocs.io
• Size: 336 KB
• Stars: 113
• Watchers: 11
• Forks: 82
• Open Issues: 49
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - sphinx-contrib/openapi - OpenAPI (fka Swagger) spec renderer for Sphinx. (Python)

README

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

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.

.. code:: bash

   $ python3 -m pip install sphinxcontrib-openapi

Usage

=====

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

.. code:: python

   extensions = [

      ...

      'sphinxcontrib.openapi',

   ]

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

.. code:: restructuredtext

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

Links

=====

* Documentation: https://sphinxcontrib-openapi.readthedocs.org/

* Source: https://github.com/sphinx-contrib/openapi

* Bugs: https://github.com/sphinx-contrib/openapi/issues

.. _Sphinx: https://www.sphinx-doc.org/en/master/

.. _OpenAPI: https://github.com/OAI/OpenAPI-Specification

.. _sphinxcontrib-httpdomain: https://sphinxcontrib-httpdomain.readthedocs.io/