swagger - 选择记录 REST API 的工具

标签 swagger documentation-generation apiary

我实际上使用 Doxygen 来记录我的 php REST 应用程序,我刚刚发现 Apiary 和 Swagger 似乎是记录 API 的好工具...我想知道是否有一种方法可以使用其中一个工具自动生成文档(养蜂场或 Swagger )基于代码注释?

最佳答案

使用 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

关于swagger - 选择记录 REST API 的工具,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/31175997/

相关文章:

c# - Swagger 的错误。服务器在处理请求时遇到错误

latex - 如何摆脱 Sphinx Latex 输出页眉中的 "Release 1"?

php - 自动生成 PHP 文档?

java - 我可以在我的 xdocreport 模板中包含其他文档/片段吗?

sails.js - 如何以api蓝图格式描述 session ?

apiblueprint - 如何使用 Apiary 记录 POST 参数?

ServiceStack & Swagger - ApiMember 作为路径和查询

java - Swagger 2.0.3 与 Spring MVC 抛出 HttpMediaTypeNotAcceptableException : Could not find acceptable representation

google-api - 谷歌 gRPC 网关 : Overriding response fields?

apiary.io - 养蜂场将多个蓝图文件合并为一个api