반응형 AsciiDoctor2 죽은 문서는 가라! Spring REST Docs로 100% 신뢰할 수 있는 API 명세서 만들기 Collaboration & Documentation신뢰도 0% 문서는 이제 그만, Spring REST Docs 도입 가이드 안녕하세요, code-resting입니다. 프론트엔드 개발자와 협업할 때 가장 곤혹스러운 순간이 언제인가요? 아마도 "문서에는 이 필드가 필수라고 되어 있는데, 실제 API를 호출하니 에러가 나요"라는 말을 들을 때일 것입니다. 오늘은 테스트 코드를 통과해야만 문서가 생성되는, 가장 정직한 문서화 도구인 Spring REST Docs를 소개합니다.1. Swagger vs Spring REST Docs두 도구는 지향하는 바가 명확히 다릅니다. 프로젝트의 성격에 따라 선택해야 합니다.🛠️ Swagger (SpringDoc)장점: 설정이 쉽고 API 테스트(Try it out)가 가.. 2026. 3. 11. AsciiDoctor 문법 1. 소개 AsciiDoctor 이란? JUNIT TEST 이후 만들어진 snippets(.adoc)파일들과 설명을 간단한 명령어들을 통해 HTML으로 변환해준다. AsciiDctor 사용 이유 API를 서비스 한다면, 사용자를 위한 명세서(문서) 작업이 필요하다. -> JUNIT TEST 코드를 기반으로 자동으로 가독성 좋은 문서화 작업이 가능하다. (비교) Asciidoctor vs Markdown -> Markdown 이 작성하기 편하지만 Include 가 되지 않은 단점이 있습니다. Slate 를 사용하면 가능하다고 하지만 결과물이 우리가 생각한 doc 파일과는 다르며 별도 설정을 해야하는 번거로움이 있습니다. 따라서 AsciiDoctor가 유리하다고 판단. 설정 방법 /src/docs/ascii.. 2021. 2. 9. 이전 1 다음 728x90 반응형
