API 문서화

Jae-Baek Song·2023년 5월 20일

Spring Rest Docs

장점

  • 테스트가 성공해야 문서작성이 된다.
  • 제품 코드에 영향이 없다.

단점

  • 문서가 추가되면 asciidoc 을 문서를 일일이 편집해야한다.
  • Swagger 에 있는 API 호출 기능을 사용할 수 없음

asciidoctor

adoc파일을 html등과 같은 파일로 파싱해주는 역할을 해주는 coverter

https://techblog.woowahan.com/2597/
https://me-analyzingdata.tistory.com/entry/Rest-Docs-%EC%82%AC%EC%9A%A9%ED%95%98%EA%B8%B0
https://tecoble.techcourse.co.kr/post/2020-08-18-spring-rest-docs/

0개의 댓글