php - 如何记录基于 Symfony 的 REST API(类似于 enunciate 的文档功能)

Question

如果我有一个用 Symfony [symfony-project.org] 框架(即 PHP)编写的基于 REST 的服务，是否有合适的工具/框架可以解析我的代码并生成 API 文档？

基于 Java 的框架 enunciate 具有与我需要的类似的文档功能，您可以在此处查看示例:http://enunciate.codehaus.org/wannabecool/step1/index.html .

我理解基于 REST 的服务的前提应该是不言而喻的，但是我正在寻找可以为我生成此文档的东西，而无需手动编写我的所有端点、支持的格式、样本输出等。

谢谢

Answer 1

不确定您是否看过Swagger前。他们似乎有一个 PHP compatible version ，虽然我个人不能真正保证。它可以自动生成一些与 enunciate 相当的 API 文档，尽管它看起来确实需要一些通过 PHP 注释的大量手动文档。话虽这么说，我认为手动工作与通过 wiki 页面制作自己的工作一样或更少，而且输出要好得多。

就像事实一样，它看起来像Enunciate has indefinite plans to eventually support other platforms ，但是 relevant Jira ticket目前正在开放等待赞助商承担这项工作。

来自ENUNCIATE-356 Jira ticket :

The first step to supporting other languages is to decouple the Enunciate model from the Java model. This work is being tracked and logged at ENUNCIATE-584. Unfortunately, it never made it out of the investigate phase because of how heavy it is. Unless a sponsor for the work is found, I don't anticipate taking that heavy load on anytime soon.

编辑:
找到一个similar question其中 someone mentions一个GitHub project dedicated to Swagger+Symfony2 . This other question相同，但没有附加信息。