vscode에서 편리한 postman 사용하기 with FastAPI

게시 2025/02/03

By SouthGlory

6 분읽는 시간

api를 테스트하는 방법은 매우 여러가지가 있습니다. 그 중에서는 아주 유명한 postman을 사용하는 방법이 있죠.

그런데 그걸 vscode의 확장프로그램으로 설치해서 사용하면 더 편리합니다.

심지어 .env에서 자동으로 환경변수를 가져와주고 동기화해주는 기능도 있습니다.

fastapi로 예제 api를 만들어 테스트해보겠습니다.

## main.py
from typing import Union

from fastapi import FastAPI
from fastapi import Request

app &#x3D; FastAPI()


@app.get("/")
def read_root():
    return {"Hello": "World!!!"}
    # return "This is string"


@app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] &#x3D; None):
    return {"item_id": item_id, "q": q}


@app.get("/get_sentiment/{text}")
def get_sentiment(text: str, user_id: Union[str, None] &#x3D; None):
    return {"text": text, "sentiment": "positive", "user_id": user_id}


@app.get("/get_sentiment_v2/{text}/{ip}")
def get_sentiment_v2(text: str, ip: str, user_id: Union[str, None] &#x3D; None):
    return {"ip": ip, "text": text, "sentiment": "positive", "user_id": user_id}


@app.post("/get_twitter_sentiment")
def get_twitter_sentiment(text: str, ip: str, user_id: Union[str, None] &#x3D; None):
    return {"ip": ip, "text": text, "sentiment": "normal", "user_id": user_id}


@app.post("/get_twitter_sentiment_v2")
async def get_twitter_sentiment_v2(request: Request):
    data &#x3D; await request.json()

    text: str &#x3D; data.get("text")
    ip &#x3D; data.get("ip")
    user_id &#x3D; data.get("user_id")

    return {"ip": ip, "text": text, "sentiment": "normal", "user_id": user_id}

python -m uvicorn main:app –reload

로 서버를 실행해준 다음, postman에서 get과 parameter post, 그리고 body post를 테스트해봅시다.

get 테스트

get요청을 보내는 get_sentiment_v2 api를 보시면 text, ip는 필수 입력이고 user_id는 선택 매개변수입니다. 필수는 “/” 뒤에 나와야 하고 선택 매개변수는 “?” 뒤에 나오면 됩니다. 그대로 입력하게 되면 다음과 같습니다.

post 테스트

post 요청을 보내는 get_twitter_sentiment 요청과 get_twitter_sentiment_v2 요청은 그 보내는 방식이 get 요청과도 다르고, 서로간에도 조금 다릅니다. 전자는 url에 매개변수를 넣어서 보내고, 후자는 data payload에 전부 매개변수를 넣어서 보냅니다.

그럼 전자부터 볼까요?

get_twitter_sentiment post 요청은 url에 모든 매개변수를 넣어서 보냅니다. 이러면 아까 했던 get요청과 뭐가 다를까요? get 요청도 url에 모든 매개변수를 넣어서 보냈었습니다.

@app.get("/get_sentiment_v2/{text}/{ip}")
def get_sentiment_v2(text: str, ip: str, user_id: Union[str, None] &#x3D; None):
    return {"ip": ip, "text": text, "sentiment": "positive", "user_id": user_id}


@app.post("/get_twitter_sentiment")
def get_twitter_sentiment(text: str, ip: str, user_id: Union[str, None] &#x3D; None):
    return {"ip": ip, "text": text, "sentiment": "normal", "user_id": user_id}

다른 점은, “/”와 “?”를 모두 사용했던 get과는 달리 post의 url에서는 필수 변수라 하더라도 경로 “/”로 들어가지 않는다는 점입니다. 모두 선택 매개변수 “?”로 들어갑니다.

이제 전자와 후자를 비교하겠습니다.

전자는 매개변수를 url에 다 넣는 것이고, 후자는 data payload에 매개변수를 넣어서 보냅니다. data payload는 다른 용어로 body입니다.

@app.post("/get_twitter_sentiment")
def get_twitter_sentiment(text: str, ip: str, user_id: Union[str, None] &#x3D; None):
    return {"ip": ip, "text": text, "sentiment": "normal", "user_id": user_id}


@app.post("/get_twitter_sentiment_v2")
async def get_twitter_sentiment_v2(request: Request):
    data &#x3D; await request.json()

    text: str &#x3D; data.get("text")
    ip &#x3D; data.get("ip")
    user_id &#x3D; data.get("user_id")

    return {"ip": ip, "text": text, "sentiment": "normal", "user_id": user_id}

Request 라는 타입은 from fastapi import Request 입니다.

get_twitter_sentiment_v2 post 요청을 보내보겠습니다.

캡처와 같이 request의 body 안에 넣을 json을 완성해서 send 하겠습니다.