Swagger 머야?

머야 Swagger

from: Spring REST API 문서를 Swagger로 만들자

REST API를 개발할때 관련 문서를 만드는 것은 꽤 귀찮은 일이다. 파라미터가 변경되거나 주소가 변경되면 실제 문서와 소스와 싱크가 맞지 않으면 아무리 문서를 잘 만들어도 소용이 없다. 변경된 소스를 그대로 문서로 만들어 주는 것이 없을까? 그런 고민을 해결해주는 것이 바로 Swagger 이다.

Swagger는 RESTfull API 문서를 만들어주는 프레임워크이다. NodeJS, Java, Python등 다양한 언어를 지원해준다.

Swagger로 API 문서화하기 - Swalloow Blog

https://www.joinc.co.kr/w/man/12/swagger

[Swagger] RESTful API 문서 만들기 feat. YAML - 이상학의 개발블로그

Swagger

Swagger의 주된 목적은 RESTful API를 문서화시키고 관리하는 것이다. 
API 문서를 일반 Document로 작성하면 API 변경 시마다 문서를 수정해야 하는 불편함이 있는데, Swagger 같은 Framework를 이용하면 이를 자동화할 수 있다. (Spring boot 사용 시)

Swagger의 주된 목적은 API 문서의 효율적 작성이지만, 필자가 중점을 둔 것은 테스트 환경의 제공이다. 
Swaager로 API 문서를 만들면 문서 자체가 API에 대한 설명이면서 Test-bed이다. 
사용자는 API 문서를 읽으면서 바로 해당 API에 대해 테스트를 해볼 수 있다.

Unit -> Black-box 테스트 과정을 통과 후 배포해도 실제 Service-level에서 오류가 발생할 수 있다. 
이러한 이유가 우리가 Open API를 사용 전 Postman으로 테스트를 해보는 이유이다. 
Swagger를 이용하면 이러한 API Test 환경을 문서와 함께 제공하기 때문에 Postman 같은 tool을 이용할 필요가 적어진다.

이것이 Swagger를 포함한 API Framework를 사용하는 이유이다.

출처: http://sanghaklee.tistory.com/50 [이상학의 개발블로그]