记录基于Symfony2的REST API的最佳实践

Question

我喜欢记录我的API（REST with JSON），它是用PHP编写的Symfony2项目。这意味着我想编写一个公共API，我可以将其发给我的客户，而不向他们展示我的内部功能等。

在公共函数（控制器等）中编写文档的最佳实践是什么？我目前正在使用YAML进行路由，这似乎与基于注释的PHPDoc不兼容。

提前谢谢！

Answer 1

然后，您应该使用专为需要记录Restful Symfony2 API而设计的NelmioApiDocBundle。

查找软件包的文档here。

它为控制器提供了ApiDoc()注释，

• The ApiDoc() Annotation。

它还允许您通过interfactive Web界面浏览整个文档，

• On-The-Fly Documentation - Web Interface。