为REST API生成DOC

时间:2010-11-18 01:32:59

标签: php api documentation documentation-generation

我已经生成了我的REST API,现在我必须为API编写文档。

由于API主要由第三方插件生成,因此无法自动生成DOC。

那么手动编写DOC的最佳工具(节省时间)是什么?

PS:我确实有github帐户,我想知道用户页面是否符合这个需求。

2 个答案:

答案 0 :(得分:2)

您可能需要查看TechWriter for Web Services。它还支持为REST API生成文档。

答案 1 :(得分:0)

您可以花一些时间将 DocBlock 放入您构建的所有功能/类中

PHPDOC这样的工具可供您将DocBlock编译成文档并重新生成您需要的任何内容(以您想要的格式)。

更不用说,存储为静态HTML