API 문서화, ApiDoc


API 문서화, ApiDoc

개요RESTFul API 개발을 하면서 API문서화는 필수적인 요소로 node.js에서 API문서화를 하기 위한 방법은 여러가지가 있습니다. 대표적으로 Swagger를 많이 사용하고 있습니다.node Swagger는 코드에 주석이 추가되는 형식으로 코드 가독성이 많이 떨어지기 때문에 새로운 API 문서화툴을 찾다가 발견하여 테스트한 결과를 작성합니다.APIDOCAPI 문서화 툴로 주석형태로 작성하여 웹페이지를 생성해주며 Java, JS, Python, Ruby, Perl... 다양한 언어를 지원하며 API 버전 비교를 지원하고 있습니다.설치설정package.json에 apidoc 설정을 추가합니다.example.js테스트를 위해 example.js를 생성합니다.Run으로 apidoc 웹페이지를 생성할 수..........



원문링크 : API 문서화, ApiDoc