swagger

이직한 회사에서 swagger라는 API UI툴을 사용하였다.

맨처음 이것을 보았을 때 이해가 되지 않는 부분이 많았으나,

문서가 제대로 없었을 때 들어가서 Request, Response가 무엇인지 모를 때 들어가서 확인해보니 진짜 좋은 툴이라고 생각을 하였다.

그렇기 때문에 사용법을 제대로 알고자 공부를 시작하겠다...

(본인은 '왜'라는 질문을 하였을 때 타당한 이유가 있는 것을 좋아한다. 그 이유는 납득이 되었을 때 효율이 매우 좋기때문이다..)

 

 

코드

 

2021. 5.5 이후 추가 진행해야할 내용

api당 설명 디테일하게 추가 및 parameter 설명 추가

현재 실패시 404로 뜨는데 이에따른 메세지 추가 globalException추가 해야할듯..? 

 

swaager란?

처음 개발하거나 혹은 유지보수를 진행할 때, API 서버가 어떤 Spec을 가진 데이터를 주고받는지에 대한 문서작업이 꼭 필요하다. 하지만 이런 문서작업은 굉장히 시간이 많이들고, API가 수정될 때마다 문서도 같이 수정해줘야 하는 번거로움을 동반한다.

 

스웨거(Swagger)는 Open Api Specification(OAS)를 위한 프레임워크로 API들이 가지고 있는 스펙(spec)을 명세, 관리할 수 있는 프로젝트이다.

 

 

 

 

 

 

 

 

 

참고

jjingho.tistory.com/8