사이드 프로젝트(4) - 스웨거(Swagger)로 API 명세서 작성하기


사이드 프로젝트(4) - 스웨거(Swagger)로 API 명세서 작성하기

스웨거(Swagger)란? 스웨거는 개발자가 REST 웹 서비스를 설계, 빌드, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크이다 - 위키백과- 스웨거를 이용하면 간편하게 API 문서를 작성할 수 있다. 뿐만 아니라 간단하게 API 테스트도 해볼 수 있다. 스웨거외에도 유명한 API 문서 툴로는 Spring Rest Docs 등이 있다. Spring Rest Docs와 스웨거는 각각의 장단점이 존재한다. 우리는 스웨거가 적용하기 간단하고, 프런트엔드와 빠른 협업을 위해 당장 테스트를 하지 않아도 문서를 만들 수 있는 스웨거를 사용하기로 했다. Spring Rest Docs는 테스트코드를 통과하지 않으면 문서를 만들 수 없기 때문이다.(이것은 단점이자 장점..


원문링크 : 사이드 프로젝트(4) - 스웨거(Swagger)로 API 명세서 작성하기