Php 为RESTAPI生成文档

Php 为RESTAPI生成文档,php,api,documentation,documentation-generation,Php,Api,Documentation,Documentation Generation,我已经生成了RESTAPI,现在我必须为该API编写一个文档 由于API主要由第三方插件生成,因此无法自动生成文档 那么,手动编写文档的最佳工具(节省时间)是什么? PS:我确实有github帐户,我想知道用户页面是否能满足这一需求。您可以花一些时间将DocBlock放入您构建的所有函数/类中 您可以使用类似的工具将DocBlock编译成文档,并重新生成所需的任何内容(转换为所需的格式) 更不用说,它存储为静态HTML,您可能想看看。它还支持为REST API生成文档。phpDocumentor

我已经生成了RESTAPI,现在我必须为该API编写一个文档

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

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


PS:我确实有github帐户,我想知道用户页面是否能满足这一需求。

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

您可以使用类似的工具将DocBlock编译成文档,并重新生成所需的任何内容(转换为所需的格式)


更不用说,它存储为静态HTML,您可能想看看。它还支持为REST API生成文档。

phpDocumentor不是为通过RESTful服务公开的API编写文档的工具。它只能用于为您的类和方法生成文档,而不是为您的RESTful服务生成文档。杜德,请阅读php描述。您能给我一个示例URL来证明您建议花费多少时间来阅读整个文档吗?我不知道您对rest结构的要求有多高,毫无疑问,你并不是在研究现有@api选项的细节——标题也不误导——OP只是在寻找一个可以为他生成文档的工具