Skip to main content

a tools for sphinx gen doc from rest api

Project description

https://travis-ci.org/yishenggudou/sphinxcontrib-sphinx-rest-api-doc.svg?branch=master https://badge.fury.io/py/sphinxcontrib-sphinx-rest-api-doc.svg

a tools for sphinx gen doc from json api

Overview

Add a longer description here.

INSTALL

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": {
      "id":"ddede"
    },
    "desc": "dwdwedewfeferferferferfewr",
    "headers": {
      "auth":"auth"
    },
    "codes": {
      "400":"de",
      "200":"2"
    }
  }
},
"model": {
  "id":"",
  "desc":"dede"
}
 }

CONFIG

in config.py

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

Project details


Release history Release notifications

Download files

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

Files for sphinxcontrib-sphinx-rest-api-doc, version 0.0.43.dev6
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib-sphinx-rest-api-doc-0.0.43.dev6.tar.gz (8.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page