반응형 스프링/Spring-Docs2 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. Spring-Docs Spring-Docs 이란? Rest API 문서 제작을 JUNIT 안에서 만드는 framework 편리/ 가독성/ TDD JUNIT 테스트 -> snippets(.adoc) 생성 → api.docs.adoc로 html5(.html) 생성 Spring-Docs 사용 이유 API를 서비스 한다면, 사용자를 위한 명세서(문서) 작업이 필요하다. -> JUNIT TEST 코드를 기반으로 자동으로 가독성 좋은 문서화 작업이 가능하다. (비교) Spring-Docs vs Swagger Spring Rest Docs Swagger 장점 제품코드에 영향이 없다 API를 테스트 해 볼수 있는 화면을 제공한다. 테스트가 성공해야 문서작성된다. 적용하기 쉽다 단점 적용하기 어렵다 제품코드에 어노테이션 추가해야한다. 제품코.. 2021. 2. 9. 이전 1 다음 728x90 반응형
