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