[Java / Spring] API 문서 자동화 Swagger
·
Spring
📕 개요 Spring뿐만 아니라 다른 어떤 언어, 프레임워크로 백엔드를 개발했을 때, Rest API를 개발하고 그 API에 대한 문서를 정리하여 해당 API를 사용하는 클라이언트 및 서버 개발자들에게 문서를 정리해서 공유하는것은 필수이다. 기존에는 노션이나 엑셀을 사용하여 정리를 했었는데 이런식으로 노션을 사용해서 정리를 했었는데 단점이 너무 많다. 일일이 코드에서 구현내용, 설계 내용들을 끌고와서 입력해야 한다. api 설계가 바뀌면 노션 문서도 수정해야한다. 그러던중 Swagger에 대해 알게 되었고, 적용해보았다. 📕 Swagger란? Swagger 는 API를 설계하고 문서화 및 테스팅이 가능한 프레임워크이며, 무료 버전과 상용 버전 모두 존재한다. Swagger 에는 아래 5개 기능이..
마볼링
'swagger' 태그의 글 목록