231123 개발일지 TIL - Postman, FastAPI, Swagger

The Web On Everything·2023년 11월 23일
0

개발일지

목록 보기
197/269

Postman

개발을 하다보면 API 문서를 활용한다.
많은 개발자들이 postman을 API 개발과 테스트에 사용하고 있다.

Postman은 API 개발, 테스팅, 문서화 등을 지원하는 플랫폼이다. Postman을 통해 API 요청을 보내고, 응답을 확인하며, 다양한 요청(GET, POST, PUT, DELETE 등)을 쉽게 테스트할 수 있다.

Postman은 팀 작업을 지원하므로, 여러 개발자들이 함께 API를 테스트하고 공유하는 것이 가능하다. 자동화된 테스트를 작성하고 실행할 수 있으며, API 문서를 자동으로 생성하고 관리할 수 있는 기능도 제공한다.

Postman은 웹 기반 인터페이스와 데스크톱 애플리케이션을 모두 제공하며, 다양한 운영체제(Windows, macOS, Linux)에서 사용할 수 있다.

FastAPI, Swagger

FastAPI는 웹 프레임워크이고
Swagger는 api 문서화 도구이다.

FastAPI는 API를 자동으로 문서화하는 기능을 제공한다.
이 기능은 Swagger UI와 ReDoc을 기반으로 하며, 이를 통해 API를 시각적으로 표현하고 테스트할 수 있다.

예를 들어
http://localhost:8000/docs 를 웹 브라우저에서 열면 Swagger UI를 볼 수 있다.
Swagger UI에서는 API의 모든 경로와 메서드를 볼 수 있고, API 호출을 직접 테스트 할 수 있다.
같은 방법으로 FastAPI에서 Swagger를 활용하여 API를 자동으로 문서화하고 테스트할 수 있다.

profile
오늘은 무슨 오류를 만날까?! 널 만나러 가는 길~ LOL

0개의 댓글