django - Tastypie文档生成

Closed. This question does not meet Stack Overflow guidelines。它当前不接受答案。












想改善这个问题吗？更新问题，以使为on-topic。

2年前关闭。



Improve this question





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

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

最佳答案

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

经过一些小的修改（我想这是由于好吃的版本差异所必需的），我在其中取得了一些成功。

编辑：我发现有必要的改编版（由于Django版本 0.9.11）现在已合并到tastypie-swagger的主线分支中。

关于django - Tastypie文档生成，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/12851898/