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

Question

我想记录一下我的API（带有JSON的REST），它是用Symfony2项目用PHP编写的。 这意味着我想编写一个公共API，我可以将其提供给我的客户，而无需向他们展示我的内部功能等。

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

先感谢您！

Answer 1

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

在此处找到捆绑包的文档。

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

• ApiDoc（）注释 。

而且，它还允许您通过交互式Web界面浏览整个文档，

• 即时文档-Web界面 。