REST API 문서 작성을위한 마크 업을 제공하는 라이브러리가 있습니까? 나는 예컨대, 여러 회사가 유사한 문서 패턴을 사용 보았다 : 그들은 같은 라이브러리 또는 서비스를 사용하는 경우 내가 궁금REST API 문서 생성
http://www.fullcontact.com/docs/?category=person
. 기본적으로 라이브러리는 마크 업 텍스트를 기반으로 API 탐색, 검색 및 표시 (루비 문서의 경우 YARD와 유사)를위한 페이지를 생성해야합니다.
이것은 내가 지금까지 발견 한 것입니다 :
당신은 확실히 Swagger을 봐야합니다.
수백 개의 API에서 사용되는 오픈 소스이며 API 관리 솔루션에서 Active Docs라는 이름으로 3scale에서 사용됩니다.
Mashery에서 IO/Docs을 확인하십시오.
차세대 API 문서 및 개발 도구 인 Mashery I/O Docs는 개발자가 직접 문서에서 실시간 API 호출을 실행할 수 있도록합니다. Think docs는 테스트 및 디버깅을 하나의 편리한 대화식 인터페이스로 모두 충족시킵니다.
위대한 문서의 또 다른 예는 Parse API Docs을 확인하십시오.
또한 우리는 FullContact API Docs을 디자인하는 데 많은 시간을 보냈습니다. 우리는 Apigee Live API Console도 사용합니다.
여러분이 문서를 생성하기 위해 보석을 제작 했습니까? 아니면 Mashery가 생성 한 페이지를 문서의 기초로 사용 했습니까? BTW, 워드 프로세서에 큰 도움이되었습니다! –
이 API를 documentaion (Rails4 및 Rails5)
ApiDoco https://rubygems.org/gems/apidoco/versions/1.2.0에 유용한 보석이다.
설정하기가 쉽고 사용자 환경이 좋습니다.
친절하게도 여기에 답변을 추가하십시오. 앞으로 외부 링크가 바뀔 수 있으므로 – Panther
을 확인하십시오. http://developer.mashery.com/iodocs –