Сфінкс-клієнта-домен плагін Сфінкс, щоб додати домен HTTP, дозволяючи документацію методів RESTful HTTP.
Ви можете документувати прості методи, обернути будь-які аргументи в дорозі з фігурні дужки:
.. HTTP: метод :: GET / API / Foo / бар / {ID} / {} пробка
& NBSP ;: аргумент ID: ID
& NBSP ;: аргумент Slug: пробка
& NBSP; Отримати список foobars відповідають заданим ідентифікатором.
Також підтримуються параметри рядка запиту:
.. HTTP: метод :: GET / API / Foo / бар / ID
& NBSP ;: парам ID: ID
& NBSP; Пошук по списку foobars відповідають заданим ідентифікатором.
Це дуже зародковому стані і експериментальний код в даний момент.
<Сильний>
Установка
Запустіть пункт встановити сфінкс-HTTP-домен.
Потім додайте до вашої sphinx_http_domain conf.py:
Розширення = ['sphinx_http_domain']
Вимоги
- Python
- Сфінкс
Коментар не знайдено