sfinks-http-domein is 'n Sphinx plugin om 'n HTTP domein voeg, sodat die dokumentasie van rustige HTTP metodes.
Jy kan dokumenteer eenvoudige metodes, draai enige argumente in die pad met krullerige draadjies-:
.. Http: metode :: KRY / api / cat / bar / {id} / {} slak
& Nbsp;: arg id: 'n ID
& Nbsp;: arg slak: 'n slak
& Nbsp; Haal lys van foobars ooreenstem gegee id.
Navraag string parameters word ook ondersteun:
.. Http: metode :: KRY / api / cat / bar / id
& Nbsp;: param id: 'n ID
& Nbsp; Soek vir 'n lys van foobars ooreenstem gegee id.
Dit is baie basiese en eksperimentele kode op die oomblik.
Installasie
Begin pit installeer sfinks-http-domein.
Dan, voeg sphinx_http_domain om jou conf.py:
uitbreidings = ['sphinx_http_domain']
Vereistes :
- Python
- Sphinx
Kommentaar nie gevind