OpenAPI (fka Swagger) spec renderer for Sphinx
Project Links
Meta
Author: Ihor Kalnytskyi
Requires Python: >=3.7
Classifiers
Topic
- Documentation
- Documentation :: Sphinx
License
- OSI Approved :: BSD License
Environment
- Console
Intended Audience
- Developers
Operating System
- OS Independent
Programming Language
- Python
- Python :: 3
- Python :: 3 :: Only
- Python :: Implementation :: CPython
Framework
- Setuptools Plugin
- Sphinx
- Sphinx :: Extension
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.
$ python3 -m pip install sphinxcontrib-openapiUsage
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.ymlLinks
0.8.4
Feb 13, 2024
0.8.3
Oct 24, 2023
0.8.2
Oct 24, 2023
0.8.1
Jan 24, 2023
0.8.0
Jan 13, 2023
0.7.0
May 07, 2020
0.6.0
Dec 19, 2019
0.5.0
Sep 05, 2019
0.4.0
Jan 17, 2019
0.3.2
Oct 05, 2017
0.3.1
May 18, 2017
0.3.0
Jan 29, 2017
0.2.1
Jan 10, 2017
0.2.0
Nov 16, 2016
0.1.0
Oct 03, 2016
