sphinxcontrib-sphinx-rest-api-doc

Pre-release

This release is a pre-release and may not be stable for production use.

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"

Download files

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

Source Distribution

sphinxcontrib-sphinx-rest-api-doc-0.0.43.dev6.tar.gz (8.1 kB view details)

Uploaded Nov 18, 2018 Source

File details

Details for the file sphinxcontrib-sphinx-rest-api-doc-0.0.43.dev6.tar.gz.

File metadata

Download URL: sphinxcontrib-sphinx-rest-api-doc-0.0.43.dev6.tar.gz
Upload date: Nov 18, 2018
Size: 8.1 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.1

File hashes

Hashes for sphinxcontrib-sphinx-rest-api-doc-0.0.43.dev6.tar.gz
Algorithm	Hash digest
SHA256	`8180a3188ef1bf8d2f4fa8b4002418c32badd0cf451ea6e7b96cee1b77c34b27`
MD5	`8a679ae98a95f1aeb9cf945096ab341d`
BLAKE2b-256	`82485ad8232796e406b71145f8104bf708883505a1d12e65dee522b839e14430`