2013-03-09 4 views
7

나는 sinatra 경로에서 API 문서를 생성하기 위해 밤새도록 찾고 있었다. 나는 인라인 코멘트로 지정할 수 있어야한다.Sinatra 빌드 REST API 문서

나는 & https://rubygems.org/gems/sinatra-croon

https://rubygems.org/gems/sinatra-api-docs을 발견했지만 모두

다른 옵션은 일부시나 플러그인 야드했다 .. 그냥 내 설치와 작동하지 않는 오래된도 있습니다,하지만하지 않습니다 문서를 생성 할 때 REST API 관련 레이아웃을 생성합니다.

누구나 알고있는 도구가 있습니까?

내가 각 경로에 대한 참조 할 모든 정보 :

대상 : 그룹

경로 :

이름 그룹

출력 : POST/

에 Params 만들

{ 
    "name": "group", 
    "members": [] 
} 

감사합니다.

답변

1

나는 Apiary.io을 확인했는데, 꽤 잘 디자인되어 있고 Markdown 스타일 도메인 특정 언어를 사용하여 API를 설명합니다. 베타 버전에서 무료로 사용할 수 있습니다.

1

Sinatra Yard을 사용해 보셨습니까? 야드에 대한 수정 사항을 포함하여 API 문서를 작성하기 위해이 API를 사용했습니다.