記錄基於Symfony2的REST API的最佳實踐

Question

我想記錄一下我的API（帶有JSON的REST），它是用Symfony2項目用PHP編寫的。 這意味着我想編寫一個公共API，我可以將其提供給我的客戶，而無需向他們展示我的內部功能等。

在公共功能（控制器等）中編寫文檔的最佳實踐是什么。 我目前正在使用YAML進行路由，這似乎與基於注釋的PHPDoc不兼容。

先感謝您！

Answer 1

然后，您應該使用NelmioApiDocBundle ，它是專門為記錄Restful Symfony2 API的需求而設計的。

在此處找到捆綁包的文檔。

它為控制器提供了ApiDoc()注釋，

• ApiDoc（）注釋 。

而且，它還允許您通過交互式Web界面瀏覽整個文檔，

• 即時文檔-Web界面 。