sphinx-http-domain

sfinx-http-domeniu este un plugin Sfinx pentru a adăuga un domeniu HTTP, care permite documentarea metodelor HTTP odihnitor.
Puteți documenta metode simple, înveliți argumente în calea cu buclat-bretele:
.. Http: Metoda :: GET / api / foo / bar / {id} / {} melc
& Nbsp;: arg id: O id
& Nbsp;: arg melc: A melc
& Nbsp; Preluare lista foobars potrivite id dat.
Parametrii șir de interogare sunt, de asemenea, sprijinite:
.. Http:? Metoda :: GET / api / foo / bar / id
& Nbsp;: param id: O id
& Nbsp; Căutați o listă de foobars potrivite id dat.
Acest lucru este foarte rudimentar și codul experimental în acest moment.

Instalare
Rulați pip instala sfinx-http-domeniu.
Apoi, se adaugă sphinx_http_domain la conf.py dumneavoastră:
extensii = ['sphinx_http_domain']

Cerințe :

• Python
• Sphinx