Skip to main content

a tools for sphinx gen doc from rest api

Project description

a tools for sphinx gen doc from json api


Add a longer description here.


pip install sphinxcontrib-sphinx-rest-api-doc

Basic usage

.. rest: path_to_model.json

example in model file

"title": "测试资源",
"desc": "测试测试测试",
"method": {
  "get": {
    "list": false,
    "path": "/api/xx/xx/xx",
    "params": {
    "desc": "dwdwedewfeferferferferfewr",
    "headers": {
    "codes": {
"model": {



extensions += ['sphinxcontrib.SphinxRest',]
rest_api_source_root = os.path.join(PROJECT_DIR, "_static", "models")
rest_api_domain = ""
rest_api_http_request_example_title = "Request Example"
rest_api_http_response_example_title = "Response Example"

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page