Swagger 란?

오늘은 가볍게 Swagger에 관해 경험삼아 정리해보려 한다. 

 

먼저 Swagger 란 어떤 것인지 한 번 정의해보자. 

 

Swagger는 개발자가 REST API 서비스를 설계, 빌드, 문서화 할 수 있도록 하는 프로젝트이다. 

즉, 쉽게 말하면 API가 담긴 문서를 만들어서 프론트 개발자에게 전달 혹은 따로 문서화 해 놓을수 있는 프로젝트이다. 

 

지금까지 일을 하면서 백엔드에서 만들어서 제공해준 API 를 많이 사용했다. 하지만 그 전까지 일일이 수기 혹은 카톡등 으로 일일이 혹은 수정사항이 있을 때 마다 요청하거나 수정을 부탁하는 등 음 상당히 아날로그적으로 작업했었다. 

 

 

 

보면 알다시피 그냥 편리함의 끝판왕이었다. 물론 정해진 속성명, 양식에 맞게 작성을 하는 백엔드에는 수고로움이 있겠지만 api문서를 받아서 본 프론트 입장에서는 그냥 와우였다. 혹시나 해서 주변 사람에게 물어보니 당연히 쓰고 있다고 했다ㅋㅋㅋ... 

 

링크 하나를 클릭해보면 관련되어 필요한 내용과 response 의 내용 등이 나오는데 

 

 

 

이렇게 api 문서들이 잘 정리된 문서들을 보면서 작업하니까 작업효율도 올라 가는 것 같다. 

 

 

 

오늘은 Swagger가 어떤 것인지 구현된 화면은 어케 보이는지에 대해 얘기해봤는데 다음에 Node 작업을 내가 할 기회가 있다면 한번 바로 작업내용과 사용법을 기록하면서 정리해보겠다. 

 

당장 사용법이 궁금한 분들은 (with Node.js)

참조

 https://gngsn.tistory.com/69

 

참조

https://lahuman.github.io/nodejs_swagger/