Symfony 기반 REST API를 문서화하는 방법 (enunciate의 문서 기능과 유사)

Question

symfony [symfony-project.org] 프레임 워크 (PHP 등)에 작성된 REST 기반 서비스가 있다면 괜찮은 도구/프레임 워크가 있습니까? 내 코드를 파싱하고 API 문서를 생성합니다.

Java 기반 프레임 워크 enunciate에는 필자가 필요로하는 것과 비슷한 문서 기능이 있습니다.이 예제는 여기 http://enunciate.codehaus.org/wannabecool/step1/index.html에서 볼 수 있습니다.

나는 REST 기반 서비스의 전제가 자명 한 것으로 알고 있지만 모든 엔드 포인트, 지원되는 형식, 샘플 출력 등을 수동으로 작성하지 않아도이 설명서를 생성하는 무언가를 쫓았습니다.

감사합니다.

Answer 1

본인이 알고있는 미디어 유형의 문서를 자동화 할 방법이 없습니다.

XHTML과 같은 미디어 유형을 사용하는 경우 Google sitemap과 같은 웹 크롤러는 리소스 간의 관계를 표시하는 유용한 출력을 생성 할 수 있습니다.

Answer 2

전에 Swagger을 본 적이 있는지 확실하지 않습니다. 그들은 PHP compatible version을 가지고있는 것처럼 보이지만 개인적으로 보증 할 수는 없습니다. enunciate에 필적하는 몇 가지 자동 API 문서 생성을 수행합니다. PHP 주석을 통해 무거운 수동 설명서가 필요한 것처럼 보입니다. 즉, 수동 작업은 wiki 페이지를 통해 직접 작성하는 것보다 같거나 적을 것이라고 생각합니다. 결과물은 훨씬 좋았습니다.

그냥 factoid, 그것은 Enunciate has indefinite plans to eventually support other platforms처럼 보이지만 relevant Jira ticket는 스폰서가 작업에 걸릴 기다리고 현재 열기입니다. ENUNCIATE-356 Jira ticket에서

:

다른 언어를 지원하는 첫 번째 단계는 자바 모델로부터 담아서 모델을 분리하는 것입니다. 이 작품은 추적 중이며 ENUNCIATE-584에 기록됩니다. 불행히도, 그것이 얼마나 무거웠는지 조사 단계에서 벗어나지 못했습니다. 그 일에 대한 후원자가 발견되지 않는다면, 나는 그 무거운 짐을 곧 내놓을 것으로 예상하지 않는다.

편집 :
는 similar question 곳 someone mentionsGitHub project dedicated to Swagger+Symfony2 발견. This other question은 같지만 추가 정보는 없습니다.