This release is a pre-release and may not be stable for production use.
sphinxcontrib-sphinx-rest-api-doc
a tools for sphinx gen doc from json api
Overview
Add a longer description here.
INSTALL
pip install sphinxcontrib-sphinx-rest-api-docBasic usage
.. rest: path_to_model.jsonexample 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"Links
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-sphinx-rest-api-doc 0.0.43.dev6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinxcontrib-sphinx-rest-api-doc-0.0.43.dev6.tar.gz | 8.1 kB | Without provenance | Details for sphinxcontrib-sphinx-rest-api-doc-0.0.43.dev6.tar.gz |
Release files / sphinxcontrib-sphinx-rest-api-doc-0.0.43.dev6.tar.gz
| Download URL | sphinxcontrib-sphinx-rest-api-doc-0.0.43.dev6.tar.gz |
|---|---|
| Size | 8.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8180a3188ef1bf8d2f4fa8b4002418c32badd0cf451ea6e7b96cee1b77c34b27
|
|
BLAKE2b-256 checksum How to use checksums |
82485ad8232796e406b71145f8104bf708883505a1d12e65dee522b839e14430
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Security for sphinxcontrib-sphinx-rest-api-doc 0.0.43.dev6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
