sphinx-http-domain là một plugin Sphinx để thêm một miền HTTP, cho phép các tài liệu về phương pháp HTTP RESTful.
Bạn có thể tài liệu phương pháp đơn giản, quấn bất kỳ đối số trong các đường dẫn với xoăn niềng răng:
.. Http: Phương pháp :: GET / api / foo / bar / {id} / {} sên
& Nbsp;: arg id: An id
& Nbsp;: arg sên: Sên
& Nbsp; Lấy danh sách các foobars phù hợp với id cho trước.
Thông số chuỗi truy vấn cũng được hỗ trợ:
.. Http: Phương pháp :: GET / api / foo / bar / id?
& Nbsp;: param id: An id
& Nbsp; Tìm kiếm một danh sách các foobars phù hợp với id cho trước.
Điều này là rất thô sơ và mã thử nghiệm vào lúc này.
Cài đặt
Chạy pip cài đặt Sphinx-http-domain.
Sau đó, thêm sphinx_http_domain để conf.py của bạn:
phần mở rộng = ['sphinx_http_domain']
Yêu cầu :
- Python
- Sphinx
Bình luận không