Slate, Swagger 2, ReDoc의 대안으로 훌륭한 API 문서 제작 툴

Slate란? Slate는 HTML 형태의 API 문서를 만들어주는 도구이다. 정확히는 Ruby 기반의 HTML 실시간 렌더링, 빌드 기능을 가진 애플리케이션이다. Slate의 강점은 낮은 학습곡선, 자유도와 생산성이다. 흔히 API 툴링시 많이 도입하는 Swagger 2, ReDoc 조합이 여의치 않을 경우 매력적인 대안이 될 수 있다. Slate 다운로드 후 하위 /source 디렉토리의 Markdown 문서들을 기반으로 API 문서를 작성하면 Slate가 미려한 UI의 반응형 웹으로 변환해준다. 실시간으로 마크다운 문서를 확인할 수 있으며 또한 배포 목적의 HTML 빌드 기능도 제공한다. Slate는 아주 간단한 Markdown 문법 만을 제공하기에 자유도가 상당히 높다. 문법 중간 중간 HTML과..
SW 개발/API 2017. 5. 16. 09:52
1