选择一个工具来记录 REST API
Choose a tools to documents REST API
我实际上使用 Doxygen 来记录我的 php REST 应用程序,我只是发现 Apiary & Swagger 似乎是记录 API 的好工具...我想知道是否有一种方法可以根据代码注释使用其中一种工具(apiary 或 swagger)自动生成文档?
使用 swagger-php
,您可以从使用注释记录的 php 脚本集合中自动生成文档。
Swagger-PHP 在这里有详细的记录:http://zircote.com/swagger-php/
可以在 github 上找到一个工作示例:https://github.com/zircote/swagger-php/tree/master/Examples/Petstore
关于包含文档的 json 文件的生成,请在此处查看我的回答:
我实际上使用 Doxygen 来记录我的 php REST 应用程序,我只是发现 Apiary & Swagger 似乎是记录 API 的好工具...我想知道是否有一种方法可以根据代码注释使用其中一种工具(apiary 或 swagger)自动生成文档?
使用 swagger-php
,您可以从使用注释记录的 php 脚本集合中自动生成文档。
Swagger-PHP 在这里有详细的记录:http://zircote.com/swagger-php/ 可以在 github 上找到一个工作示例:https://github.com/zircote/swagger-php/tree/master/Examples/Petstore
关于包含文档的 json 文件的生成,请在此处查看我的回答: