Skip to content

sevdog/openapi

This branch is 1 commit ahead of, 7 commits behind sphinx-contrib/openapi:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

fa78d72 · Oct 15, 2024
Jan 13, 2023
Apr 5, 2020
Oct 15, 2024
Oct 24, 2023
Mar 28, 2020
Dec 10, 2018
Feb 15, 2017
Oct 24, 2023
Feb 13, 2024
Sep 23, 2016
Sep 23, 2016
Jan 4, 2020
Nov 22, 2023
Dec 7, 2022

Repository files navigation

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.

$ python3 -m 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

About

OpenAPI (fka Swagger) spec renderer for Sphinx.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%