✏️ Swagger 문서보기

 

 

 

---

 

Swagger는 무엇인가?

Swagger은 애플리케이션의 `RESTful API`문서를 자동으로 구성해주는 도구이다.

Swagger를 사용하면 API버전 관리가 용이해지고 다양한 API 메서드를 볼 수 있다!

또한 Swagger의 UI를 이용하면 API호출 결과가 어떻게 되는지 쉽게 테스트하고, 확인해 볼 수 있다.

백엔드 개발자분이 만들어주시면, 그 문서를 이용하여 프론트는 어떻게 활용하면 되는지 한눈에 볼 수 있다.

예전에 퍼블리셔로 일했을 때, 개발자 분이 이 문서를 종종 보는 것을 봤는데 (심지어 나한테 설명도 해주셨던 기억이...😂)

드디어 나도 프론트를 공부하면서 직접 써먹어 볼 수 있게 되었다🔥

 

 

실무에 가면 Swagger이외에도 다른 것을 사용할 수 있는데

Docs를 못받았으면 API Docs를 요청하면 백엔드 개발자분이 주소를 주신다!

백엔드 개발자분이 기존에 어떻게 해오셨는지 물어보고, 다음에 해당하는 API를 달라고 요청하면 주신다!

 

 

 

 

 

연습용으로 받은 링크를 가져왔다.

백엔드 개발자분이 주신 링크를 타고 들어가면

앞에 있는 내용 method(메소드)를 확인해볼 수 있고, 오른쪽엔 Endpoint(앤드포인트)들이 나와있다.

각각의 내용을 클릭하면 좀 더 상세하게 내용들이 나온다.

 

 

 

 

 

 

 

응답 예시로도 이렇게 나와있고,

오른쪽에는 json데이터로 받는다는 뜻이다.

 

 

Try it out 버튼을 클릭하여

요청을 직접 날려볼 수 있다.