FastAPI 프레임워크 간단 서버 구축

FastAPI

FastAPI란?

- 파이썬 기반 오픈소스 웹 프레임워크

- "FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints."

 

FastAPI 특징

• 빠름: (Starlette과 Pydantic 덕분에) NodeJS 및 Go와 대등할 정도로 매우 높은 성능. 사용 가능한 가장 빠른 파이썬 프레임워크 중 하나.
• 빠른 코드 작성: 약 200%에서 300%까지 기능 개발 속도 증가. *
• 적은 버그: 사람(개발자)에 의한 에러 약 40% 감소. *
• 직관적: 훌륭한 편집기 지원. 모든 곳에서 자동완성. 적은 디버깅 시간.
• 쉬움: 쉽게 사용하고 배우도록 설계. 적은 문서 읽기 시간.
• 짧음: 코드 중복 최소화. 각 매개변수 선언의 여러 기능. 적은 버그.
• 견고함: 준비된 프로덕션 용 코드를 얻으십시오. 자동 대화형 문서와 함께.
• 표준 기반: API에 대한 (완전히 호환되는) 개방형 표준 기반: OpenAPI(이전에 Swagger로 알려졌던) 및 JSON 스키마

 

 

설치

pip install fastapi

pip install "uvicorn[standard]"

- 실시간 미리보기, 프로덕션을 하고 싶으면 uvicorn(ASGI 서버)도 설치해준다. 

 

from fastapi import FastAPI
app = FastAPI()

#메인페이지로 접속시 'hello'보내기
@app.get("/")
def comment():
    return 'hello'

간단하게 유저가 메인페이지 접속시 hello를 표시하도록 기능을 추가하였다.

 

uvicorn을 실행해서 결과물을 확인할 수 있다.

uvicorn main:app --reload

위와 같은 결과가 나오게 되는데 링크된 주소로 들어가면 hello가 출력되는 결과물을 확인할 수 있다.

 

 

간단하게 기능을 하나 더 추가해보면

from fastapi import FastAPI
app = FastAPI()

#메인페이지로 접속시 'hello'보내기
@app.get("/")
def comment():
    return 'hello'

#추가 기능 : 경로를 설정한 후 보내줄 데이터를 임의로 설정해보았다.
@app.get("/test")
def comment():
    return {'hi' : 1234}

위에 표시된 주소 링크에 /test를 추가하면(http://127.0.0.1:8000/test) 제대로 되는지 확인이 가능하다.

 

추가적으로 http://127.0.0.1:8000/docs를 실행시키면 본인이 만든 기능이 어떤 것들이 있는지 문서화 하여 보여준다.

 

다음으로 메인페이지 접속시 html 파일 전송과 같은 기능을 하고 싶다면

from fastapi.responses import FileResponse

위 코드를 추가하면 가능하다.

 

html파일을 생성해보자

<div> 안녕 </div>

from fastapi import FastAPI
app = FastAPI()

from fastapi.responses import FileResponse

#메인페이지 접속시 html파일 전송
@app.get("/")
def comment():
    return FileResponse('intex.html')

메인페이지에 html파일이 전송되니 것을 확인할 수 있다.

 

 

from typing import Optional
from fastapi import FastAPI
from pydantic import BaseModel

class Book(BaseModel):
    name: str
    content: Optional[str] = None
    price: int

app = FastAPI()

@app.post("/books/")
async def create_book(book: Book):
    return book

위와같이 app.post()를 이용해 유저에게 데이터를 받을 수 있다.

 

코드는 BaseModel을 상속한 Book이라는 새로운 모델을 생성한 것이다.

 

{
    "name": "james",
    "content": "An optional description",
    "price": 100
}

위 JSON 객체를 입력받고 request body로 설정하여 API를 호출한다

---

백엔드는 처음이라 아직 이해가 완벽히 되지 않는다