Swagger란?

 

🚀 Swagger에 대하여

    🔽  개요

Swagger(스웨거)는 개발자가 `REST` Web Service를 설계, Build, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 Open Source Framework인 것이에요. 대부분의 이용자들은 Swagger UI 도구를 통해 Sagger를 식별하며, Sagger Tool Set에는 자동화된 문서화, Code 생성, Test Case 생성 지원이 포함되는 것이에요.

 

반응형

 

Swagger를 이용하게 되면 API 문서를 개발자가 따로 작성할 필요없이 Code만 작성해 주면 알아서 Web Page를 만들어 문서를 보여주는 도구인 것이에요.

 

 

 

 

    🔽  Swagger(API 문서) 활용법

Swagger를 이용해서 API 문서를 만들면 위와 같이 내가 설정한 내용에 대해 확인할 수가 있습니다.

 

`signup`에 대한 내용을 한번 살펴볼게요.

먼저 해당 API HTTP Method는 `post`인 것이 보이고, URL은 /signup으로 접근해야 하는 걸 알 수 있습니다.

그리고, 매개변수는 3가지를 받게 되는데, 이용자의 ID, 비밀번호, 닉네임을 받도록 처리가 되어 있네요.

참고로 빨간색으로 `required`라고 되어 있다면 필수 입력값이라는 것이에요.

 

이 부분은 API 개발자가 HTTP Response Code에 대해 정리를 해 두고, 이것을 확인하면서 FrontEnd 개발자가 확인할 수 있도록 할 수 있는 것이에요.