[FastAPI] Postman API 소개

오늘은 제가 프로젝트를 진행하면서 여러 API를 발급하고 API를 확인하는 프로그램을 소개해 드리겠습니다. 제가 소개할 프로그램은 Postman 이라는 프로그램입니다. 아래 사이트에 들어가셔서 무료로 다운로드할 수 있는 프로그램입니다. 제가 이 프로그램을 추천하는 이유는 여러 메소드를 편리하게 테스트할 수 있고 웹소켓을 사용할 수 있어서입니다.

https://www.postman.com/

Postman API Platform | Sign Up for Free

 

메인화면

먼저 설치해서 접속하면 이러한 메인화면을 볼 수 있습니다. (참고로 저는 macOS 에서 진행했습니다) 그리고 new 버튼을 누르게 되면 아래와 같이 옵션을 선택하는 창이 나오게 됩니다. 여기서 일반 메소드를 테스트하려면 HTTP를 웹소켓을 테스트하려면 WebSocket을 골라 주시면 됩니다.

 

HTTP

HTTP를 선택했다면 아래와 같은 창이 나오게 되는데 밑의 화살표 버튼을 눌러서 메소드를 선택할 수 있습니다.

그리고 메소드를 선택했다면 밑에 Body를 선택해서 JSON 형식으로 데이터를 받고 싶다면 raw의 JSON을 골라주시면 됩니다. 이 부분은 프로젝트를 진행하면서 필요한 상황에 맞춰서 변경해 주시면 됩니다. 예시로 저번 글에서 사용했던 코드를 사용해서 테스트를 진행해 보겠습니다.

 

예시

먼저 fastapi 코드를 작성해 주고 실행해 줍니다. 예시 코드는 이렇게 작성했습니다.

from fastapi import FastAPI

app = FastAPI()

@app.get("/users/{user_id}")
async def read_user(user_id: int):
	return {"user_id":user_id}

유저 아이디를 받아서 출력해주는 간단한 GET 메소드 코드입니다. 위 코드를 uvicorn을 통해서 실행시켜 주고 postman을 통해서 테스트를 진행하게 되면

Send 버튼을 통해 신호를 주었을 때 및에 200 OK 라는 성공 신호와 함께 지정해 둔 메시지가 Body를 통해 전송되는 것을 확인할 수 있습니다. 그리고 사진에는 나와있지 않지만 주소를 작성하고 저장해 둘 수 있어서 자주 테스트하는 항목들을 편하게 관리할 수 있다는 장점이 있습니다.

 

정리

오늘은 Postman을 통해서 API를 확인하는 방법에 대해 알아봤습니다. FastAPI의 docs 기능과 함께 사용하면 백엔드 개발 시 매우 유용하게 사용되는 툴이라고 생각합니다. 간단한 예제만 보여드렸는데 다른 메소드들도 동일한 방식으로 작동하기 때문에 본인의 프로젝트에 맞게 수정해서 사용하시면 활용가능할 것이라고 생각합니다. 아 그리고 웹소켓 관련해서 보여드리지 못했는데 다음에 웹소켓에 대한 글로 자세하게 설명하는 글을 작성해 보도록 하겠습니다.