Passwd

[FastAPI] request body 예시 추가하기

개요최근 FastAPI로 API 개발을 하고 있는데, API 문서에 API 요청 방법에 대한 예시가 있으면 좋을 것 같다. 확인해 보니 요청 데이터 예시를 추가할 수 있는 방법이 있어 이번 글을 통해 정리해두려고 한다.  Pydantic 모델에 추가Pydantic 모델에 json_schema_extra 설정으로 examples을 추가하면 예시 request body를 지정할 수 있다.예시 request body는 딕셔너리 리스트로 전달한다. (여러 개를 전달해도 API 문서에는 하나만 표시되는 것 같다.)from fastapi import FastAPIfrom pydantic import BaseModelapp = FastAPI()class Item(BaseModel): name: str de..

[FastAPI] API 문서 접근 시 404 Not Found 현상 해소

현상FastAPI는 API 문서를 자동으로 생성하는 기능을 제공하고 있어 기본적으로 /docs, /redoc 경로로 접근하면 개발한 API의 문서를 확인할 수 있다.최근 개인 컴퓨터가 아니라 별도의 개발 환경에서 FastAPI를 사용해 개발을 진행하고 있는데, API 문서를 확인하려고 했더니 아래와 같은 화면과 함께 오류가 발생했다.현상을 해결해 보자.  원인이 현상은 prefix가 제거된 프록시가 있을 때 발생한다. prefix가 제거되었다는 것은 FastAPI 내에서는 root 아래에서 제공하고 있는 경로가 FastAPI 외에서는 경로가 추가된 상태고 제공하고 있는 것을 의미한다. 예로 들면 FastAPI에서 /app 경로를 선언했으나, 실제 서비스에서는 /api/v1이라는 prefix를 추가하여 /..