최근에 Rest API 설명서를 수신하기 시작했으며 API에 대한 자동 문서화에 관심이 많습니다.나머지 API 설명서 자동 생성
API의 표준 방법에 대한 문서를 생성 할 수있는 자동 도구가 있습니까? 필자는 오픈 소스 도구에 관심을 보이고 있지만 필자의 요구에 맞는다면 유료 솔루션에 대해서는 아무런 답변도하지 않을 것입니다. 자동 xml 문서가 포함 된 경우에도 큰 도움이 될 것입니다.
설명서가 재미 있고 사용하기 쉬운 솔루션이 있습니까?
이렇게 할 수있는 많은 옵션이 있습니다. This article 인기 옵션 소수의 목록을 제공합니다
"자체 문서화 REST 프레임 워크"에 대한 인터넷 검색을 제공합니다 더 많은 옵션. 각 옵션에 대한 조사를 해보시고 귀하의 필요에 맞는 것을 찾을 수있을 것이라고 확신합니다.
Guzzle을 사용하는 경우 PHP API 클라이언트 라이브러리, 서비스 문서는 정말 멋집니다.
http://service-docs.adeslade.co.uk/
그것은 사용을 폭식 같은 JSON "서비스 설명"에서 컴파일하고 실제로 API에 요청을 보내고 응답을받을 수 있다는 것을 의미 문서의 HTML에 내장 된 목구멍 클라이언트와 함께 제공 문서 자체 내에서
변경 사항이있을 때마다 업데이트하지 말고 Guzz에 대한 서비스 설명을 최신 상태로 유지하면 문서가 업데이트됩니다.
@tonicsoft은 여러 가지 좋은 옵션을 제공합니다. 또한 "RESTful API를 문서화하는 표준 방법"에 대한 질문의 대답은 brief but helpful comments on the above options, plus a few more을 제공합니다.
안녕하세요 @tonicsoft. 약간의 연구 후 나는 비틀 거리는 것을 끝내었다. 도움을 주셔서 감사 드리며 저를 기쁘게합니다. –