选择用于文档REST API的工具

时间:2015-07-02 05:08:32

标签: swagger documentation-generation apiary

我实际上使用Doxygen来记录我的php REST应用程序,我发现Apiary& Swagger女巫似乎是记录API的好工具...我想知道是否有一种方法可以根据代码注释使用这些工具(养蜂场或者招摇)自动生成文档?

1 个答案:

答案 0 :(得分:2)

使用swagger-php,您可以使用注释记录的一组php脚本自动生成文档。

Swagger-PHP在这里得到了很好的记录:http://zircote.com/swagger-php/ 可以在github上找到一个工作示例:https://github.com/zircote/swagger-php/tree/master/Examples/Petstore

关于生成包含文档的json文件,请在此处查看我的答案:https://stackoverflow.com/a/31178997/2853903