restdocs-to-postman 소개

Problem

Spring rest docs 를 사용하면 curl 형태로 된 adoc snippets들이 생성이된다.

현재 작업 중인 API에 도입하기 위해 우아한 형제들의 기술 블로그에서 해당 내용의 글 참고했다.

Requirement

• 문서의 생성이 빌드과정에서 자동으로 이루어져야한다.
• 생성된 문서가 문서 관리 시스템(confluence)으로 배포 되어야 한다.
• client 개발자들이 선호 하는 Tool인 postman의 collection 파일도 첨부되었으면 한다.

Solution

• 빌드 과정에서의 asciidoc 문서 생성 : spring rest docs, spring rest docs mock
• Confluence 로의 publishing : asciidoc-confluence-publisher-maven-plugin
• adoc 파일로 부터 postman collection 파일 생성 : restdocs-to-postman