Symfony2 기반 REST API 문서화 모범 사례

Question

Symfony2 Project로 PHP로 작성된 API (REST with JSON)를 문서화하고 싶습니다. 이것은 내 내부 기능 등을 보여주지 않고 내 고객에게 줄 수있는 공용 API를 작성하고자 함을 의미합니다.

공용 기능 (컨트롤러 등)에 문서를 작성하는 가장 좋은 방법은 무엇입니까?). 현재 YAML을 라우팅에 사용하고 있는데, 주석 기반 PHPDoc과 호환되지 않는 것 같습니다.

미리 감사드립니다.

Answer 1

그런 다음 Restful Symfony2 API를 문서화해야 할 목적으로 특별히 설계된 NelmioApiDocBundle을 사용해야합니다.

번들 설명서 here을 찾으십시오.

그것은 컨트롤러에 대한 ApiDoc() 주석을 제공

• The ApiDoc() Annotation.

그리고 그것은 또한 당신이 interfactive 웹 인터페이스를 통해 전체 문서를 탐색 할 수 있습니다,

• On-The-Fly Documentation - Web Interface.