REST API Framework Swagger 탐방기 2부

REST API Framework Swagger 탐방기 2부

 

1부에서 대충 Swagger가 무엇을 하는 것이지 알아보았는데요

대충 요약을 해보자면

1.     REST API 스펙을 정의한다

2.     스펙에 맞는 REST API Document 페이지를 만들어준다.

3.     필요하면 REST API 서버도 만들어준다.
(물론 Business Logic은 비어 있어요)

정도가 되겠네요

 

계속 설명만 보니까 뭔가 사알짝 부족한 감이 있네요

더 이상은 실제로 어떻게 동작하는지를 봐야 할 것 같네요

 

마침 홈페이지에 Live Demo가 있네요

그래서 한번 들어가 봤습니다.

 

Swagger를 통해서 만들어진 REST API Document 페이지는 이런가 봅니다.

리소스 별로 그룹화 되어서 나오네요

 

이런 식으로 메뉴 확장을 통해 구현된 API 리스트를 확인할 수 있네요

Method, URL 그리고 API 요약 설명이 나오는 것 같아요

Deprecated된 API /Deprecated 이런 식으로 표시도 되네요

API 리스트 아이템을 클릭하면 해당 API의 상세 정보를 확인할 수 있는데요

 

제일 먼저 주의사항이 나오네요. 하나의 단일 애완동물의 정보를 반환하나 보네요

그리고 API Response 형태를 알려주는 것 같네요.

Http 응답 상태 코드로 구분해서 보여주는 듯 합니다. 상태 코드에는 대표적으로

 

등등 훨씬 많지만, 보통 성공했을 때는 필수적으로 작성하고,

실패했을 경우 몇 가지 정도로 크게 나눠서 명세하는 듯 하네요

  

기본적으로 Example Value로 선택되어 있는데요. 실제 API 요청에 대한 응답을 볼 수 있네요.

  

Live Demo는 json 형태뿐만 아니라 xml 형태도 지원하는 모양이네요

 

Model을 선택 하게 되면, 실제 API 응답을 구성하는 모델을 확인할 수 있네요

(물론 저 모델을 구성하는 것이 우리가 할 일이겠죠)

 

하단에 보면 실제로 API 테스트를 할 수 있는 부분이 있는데요

[Try it out!] 을 누르면 API 요청을 할 수 있는데요

(개인적으로 마음에 드는 부분이죠)

 

필수적인 Parameter를 입력하지 않으면, 요청이 정상적으로 이루어지지 않습니다.

 

위와 같이 정상적인 요청을 하게 되면

다음처럼 상세한 응답을 확인할 수 있습니다.

 

3부에서 다시 찾아오겠습니다.