sphinxcontrib-openapi
Advanced tools
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
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
.. _Sphinx: https://www.sphinx-doc.org/en/master/ .. _OpenAPI: https://github.com/OAI/OpenAPI-Specification .. _sphinxcontrib-httpdomain: https://sphinxcontrib-httpdomain.readthedocs.io/
FAQs
OpenAPI (fka Swagger) spec renderer for Sphinx
We found that sphinxcontrib-openapi demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
