sphinx-http-domein is een Sphinx plugin om een HTTP-domein toe te voegen, waardoor de documentatie van RESTful HTTP methodes.
U kunt documenteren eenvoudige methoden, wikkel alle argumenten in het pad met krullend-braces:
.. Http: methode :: GET / api / foo / bar / {id} / {slug}
& Nbsp;: arg id: Een id
& Nbsp;: arg slug: Een slug
& Nbsp; Ophalen lijst van foobars bijpassende gegeven id.
Query string parameters worden ook ondersteund:
.. Http:? Methode :: GET / api / foo / bar / id
& Nbsp;: param id: Een id
& Nbsp; zoeken voor een lijst van foobars bijpassende gegeven id.
Dit is zeer rudimentair en experimentele code op het moment.
Installatie
Run pip installeren sphinx-http-domein.
Vervolgens voegt sphinx_http_domain aan uw conf.py:
extensies = ['sphinx_http_domain']
Eisen
- Python
- Sphinx
Reacties niet gevonden