반응형 openapi31 API 문서화 - RestDocs 와 Swagger 함께 사용하기 개요API 문서화 도구인 RestDocs와 Swagger 는 장단점이 매우 명확하다. Swagger는 어노테이션을 추가해서 빠르게 API 명세를 작성할 수 있고, 웹 UI와 API 테스트를 제공하는 매우 큰 장점이 있다. 하지만 애플리케이션 코드에 API 명세 목적의 코드가 추가되기 때문에 다소 지저분해질 수 있다. RestDocs는 테스트 코드 작성을 통해 API 명세를 작성할 수 있다. 테스트 코드를 강제하고, 애플리케이션 코드 (비지니스 로직) 과 명세 목적의 코드를 분리할 수 있다는 장점이 있다. 하지만 일부 문서를 수동으로 작성해야 한다. 나는 RestDocs가 테스트 기반으로 문서를 생성하기 때문에 신뢰성을 높일 수 있어서 좋았다. 그리고 애플리케이션 코드와 명세 목적 코드가 섞이는 것이 싫어.. 2024. 8. 8. 이전 1 다음 반응형
