現在、Symfony2 を使用して RESTful API を構築しています。
シンプルでクリーンなドキュメントを作成するために、私はapidoc.jsを使用したいと考えています(私はこれを使用したいと思っていますが、API ドキュメントを自動生成するものが他にある場合は、自由に共有してください)。
このジェネレーターは、Symfony カーネルによって解析される注釈を使用します (明らかに、私が理解していることから)
これがコントローラーの私のコードです
/**
* @api {get} /contact/list Request Contacts List
* @apiName List Contacts
* @apiGroup Contacts
*
* @apiSuccess {Integer} Status
* @apiSuccess {String} Custom Message to be displayed
*/
public function clientListAction(){}
悲しいことに、Symfony はこれを解析し、エラーをスローします:
[Semantical Error] The annotation "@apiName" in method AppBundle\Controller\ClientApiController::clientListAction() was never imported.
Symfony が注釈を解析するのを防ぐ (私は常に YAML を使用しているため、Symfony の注釈は実際には役に立たない) か、単にそれらをインポートするための解決策がありますか?
私はこれにまったく慣れておらず、信頼性の高いクリーンな Symfony アプリケーションの作成にまだ苦労しています。