Sfinks-http-domena jest plugin Sfinks dodać domenę HTTP, dzięki czemu dokumentację REST metod HTTP.
Możesz udokumentować prostych metod, owinąć żadnych argumentów na drodze z kręcone szelki:
.. Http: Metoda :: GET / api / foo / bar / {id} / {ślimak}
& Nbsp;: arg id: id
& Nbsp;: arg Ślimak: ślimak
& Nbsp; listy foobars odpowiadających podanym ID Pobierz.
Obsługiwane są również parametry ciągu zapytania:
.. Http: Metoda :: GET / api / foo / bar / id
& Nbsp;: param id: id
& Nbsp; Szukaj liście foobars odpowiadających podanym ID.
To jest bardzo ograniczony i kod eksperymentalne w tej chwili.
Instalacja
Uruchom pip install sfinks-http-domeny.
Następnie dodaj sphinx_http_domain do conf.py:
Rozszerzenia = ['sphinx_http_domain "]
Wymagania :
- Python
- Sphinx
Komentarze nie znaleziono