Swagger와 Postman

백앤드 개발을 시작하면서 가장 어려웠던 부분은 처음에 백앤드 개발이란 무엇인가에 대해 감을 잡는 것이였다.

 

여태 개발 공부라 해봐야 혼자 CRUD 계시판 만들기, Django에서 로그인 회원가입 구현해보기 정도가 전부였던 나에게 html, css 즉, 프론트앤드의 화면 없이 오직 API만 개발해보라고 하니 당연히 당황스러울 수 밖에 없었다.

어디서부터 어떻게 시작해야할지 감이 잡히지 않아서 시작조차 못하고 있었다.

 

이런 경우 사용 할 수 있는 툴이 바로  swagger와 postman이다. 우리에게 없는 프론트앤드 화면을 대신해 준다고 생각하면 편하다. API를 만들었을 때, 요청을 보내보고 response body를 받아 API가 제대로 작동하는지 확인 할 수 있게 해준다.

 

#1 Swagger, Postman은 무엇인가?

Swagger란?
RESTful API를 설계, 빌드, 문서화 및 소비하는 데 도움을 주는 오픈 소스 프레임워크이다. Swagger는 API의 구조를 정의하고, 이를 시각화하여 API 소비자들이 이해하고 사용할 수 있도록 도와준다.

주요 기능

자동 문서화 : 코드와 API 정의 파일을 기반으로 자동으로 API 문서를 생성

인터랙티브 테스트 : API 문서 내에서 직접 API 호출을 테스트

표준화 : OpenAPI Specification에 따라 API를 정의하여, 표준화된 방식으로 API를 설계

 

Postman란?
Postman은 API 개발을 위한 협업 플랫폼으로, API 테스트와 요청 시뮬레이션, 문서화 등을 위한 도구이다. API 요청을 생성하고, 응답을 분석하며, 테스트 스크립트를 작성하는 등의 작업을 쉽게 할 수 있다.

 

주요 기능

API 요청 작성 및 테스트 : HTTP 메서드(GET, POST, PUT, DELETE 등)를 사용하여 API 요청을 작성하고 테스트

환경 변수 : 다양한 환경에 맞춰 변수를 설정. 환경 변수로 API 요청을 동적으로 구성할 수 있다.

테스트 스크립트 : JavaScript로 작성된 테스트 스크립트를 사용하여 API 응답을 검증할 수 있습니. 테스트 자동화를
통해 지속적인 통합과 배포(CI/CD) 파이프라인에 쉽게 통합할 수 있다.

API 문서화 : 컬렉션을 기반으로 자동으로 API 문서를 생성

 

#2 Swagger와 Postman의 차이점은?

• Swagger는 API의 정의와 문서화에 중점을 두고 있다. 코드 생성 기능을 통해 개발 효율성을 높이는 데 유용하고, API를 처음 설계하고 문서화하는 과정에서 특히 유용하다.
• Postman은 API 요청을 테스트하고 관리하는 데 중점을 두고 있으며, 다양한 테스트 스크립트와 자동화 기능을 제공한다. API 개발 및 디버깅, 팀 협업에 특히 적합!!