django - Tastypie 文档生成

Question

关闭。这个问题不符合Stack Overflow guidelines .它目前不接受答案。












想改进这个问题？将问题更新为 on-topic对于堆栈溢出。

4年前关闭。




Improve this question




我正在尝试使用自动文档工具为 Tastypie REST API 生成 API 文档。我尝试了 Tastytool，但它似乎没有显示 API 的结果参数，而是显示模型的列。然后我尝试了 Sphinx 似乎更有希望，因为 Tastypie 支持 Sphinx，但我找不到一个示例来说明在哪里以及如何在代码中为 API 放置注释，并将它们生成到文档中。

任何人都可以分享一些关于正确撰写评论并为基于 Tastypie 的 API 生成 Sphinx 文档的信息或示例？谢谢。

Answer 1

您可能想看看 tastypie-swagger , 它使用 Swagger为您的 Tastypie 生成/doc/页面API。

经过一些小的调整(我想这是由于 Tastypie 版本的差异，这是必要的)，我已经取得了一些成功。

编辑:我认为必要的调整(由于 django 版本 < 1.4 和 sweetpie 版本 > 0.9.11)现在被合并到 sweetpie-swagger 的主线分支中。