Swagger를 왜 사용할까 ?

Swagger가 나오기 전에는 ?

• 백엔드 개발자가 문서로 일일이 URL 및 요청(Request), 응답(Response)를 적어서 프론트엔드 개발자에게 전달하는 방식이었다. → API를 테스트하기 위해선, Postman이나 cURL로 직접 URL 및 Request를 작성해야 했다.
• 요구사항 그대로 완벽히 구현했다고 하더라도 요구사항이 바뀌어 API가 변경되면 문서를 다시 수정해야 하는 번거로움이 있다.

Swagger가 나온 이후로

• API 문서를 만들 때, 개발자가 문서를 직접 작성하지 않아도 되므로 개발 시간이 단축되었다.
• Swagger UI를 사용하면 API를 쉽게 테스트 가능하며, API 호출 시 전달해야 할 파라미터도 확인할 수 있다 !
• API 버전 관리도 용이해지고 다양한 API 문서를 통합할 수도 있다.

Swagger를 구성하는 두 가지 방법

YAML 파일 사용

• [ ] Swagger UI를 위한 서버를 따로 두고, Swagger에서 API 요청을 하면 그 요청을 해당 서버로 전달하는 방식으로 동작한다.