我正在尝试使用自动化文档工具为Tastypie REST API生成API文档。我尝试了Tastytool，但它似乎只显示模型的列而非API的结果参数。然后我尝试使用Sphinx，因为Tastypie支持Sphinx，但是我无法找到如何在代码中添加API注释并将其生成到文档中的示例。
有人可以分享一些关于如何正确编写注释和为基于Tastypie的API生成Sphinx文档的信息或示例吗？谢谢。
3个回答
13
您可能想看一下 tastypie-swagger，它使用 Swagger 为您的 Tastypie API 生成/doc/页面。
我已经在进行了少量修改后成功使用它（这些修改是由于 tastypie 版本差异而必要的，我想）。 编辑： 我所发现的必要修改（由于 Django 版本小于1.4和 tastypie 版本大于0.9.11）现在已合并到 tastypie-swagger 的主线分支中。
我已经在进行了少量修改后成功使用它（这些修改是由于 tastypie 版本差异而必要的，我想）。 编辑： 我所发现的必要修改（由于 Django 版本小于1.4和 tastypie 版本大于0.9.11）现在已合并到 tastypie-swagger 的主线分支中。
- tcmb
1
tastypie-swagger不支持最新的Django版本。有什么克服这个障碍的想法吗？谢谢。 - Jaswanth Manigundan
0
也许我完全没有理解你的问题，但如果你只是想构建源代码分发附带的文档，那么在docs目录中有一个Makefile执行必要的操作。你需要指定目标输出类型，例如html、json、latex等。我保留了django、tastypie和slumber的本地文档副本，因为我同时使用这三个选项，并经常使用
如果我对你想要实现的内容有误解，也许我们可以澄清一下。
make html选项。如果我对你想要实现的内容有误解，也许我们可以澄清一下。
- zzzirk
2
抱歉没有澄清我的问题。我可以使用Sphinx内置的命令行生成文档，但我找不到在我的代码中为每个API放置评论并将它们生成到文档中的正确位置和格式。 - Jason Xu
你是在尝试为使用Tastypie的自己的API类编写Sphinx文档吗？ - zzzirk
网页内容由stack overflow 提供, 点击上面的可以查看英文原文，
原文链接
原文链接