Tạo tài liệu Tastypie

Question

Tôi đang cố gắng sử dụng công cụ tự động hóa để tạo tài liệu API cho API REST ngon miệng. Tôi đã thử món ăn ngon, nhưng có vẻ như không hiển thị các thông số kết quả của api mà là các cột của mô hình. Sau đó, tôi đã cố gắng Sphinx có vẻ hứa hẹn hơn vì Tastypie hỗ trợ Sphinx, nhưng tôi không thể tìm thấy một ví dụ để chỉ ra nơi & cách đặt nhận xét cho API bên trong mã và tạo chúng vào tài liệu.

Bất kỳ ai cũng có thể chia sẻ một số thông tin hoặc ví dụ về cách viết bình luận và tạo tài liệu Sphinx cho API dựa trên Tastypie? cảm ơn.

Answer 1

Bạn có thể muốn xem tastypie-swagger, sử dụng Swagger để tạo/doc/trang cho API Tastypie của bạn.

Tôi đã có một số thành công với nó, sau một vài chỉnh sửa nhỏ (đó là cần thiết do sự khác biệt phiên bản ngon, tôi giả sử).

Chỉnh sửa: Các chỉnh sửa mà tôi thấy cần thiết (do phiên bản django < 1.4 và phiên bản boldpie> 0.9.11) hiện được hợp nhất thành nhánh chính của tiếng ruồi.

Answer 2

Có lẽ tôi hoàn toàn thiếu điểm câu hỏi của bạn nhưng nếu bạn chỉ đang cố gắng xây dựng các tài liệu đi kèm với phân phối nguồn có một tệp Makefile trong thư mục tài liệu thực hiện các hành động cần thiết. Bạn được yêu cầu chỉ định loại đầu ra đích như html, json, latex, v.v. Tôi giữ một bản sao cục bộ của tài liệu cho django, ngon, và ngủ khi tôi sử dụng cả ba kết hợp với nhau và tôi sử dụng tùy chọn make html thường xuyên.

Nếu tôi nhầm lẫn về những gì bạn đang cố gắng thực hiện có lẽ chúng tôi có thể làm rõ một số điều.

Answer 3

Ngoài ra còn có Django Tasty Docs là một phần của Tasty Tools