본문으로 건너뛰기

"fastapi" 태그로 연결된 3개 게시물개의 게시물이 있습니다.

모든 태그 보기

· 약 5분
karais89

환경

  • Windows 10
  • Pycharm 2021.1.2
  • Github

포스팅 목적

  • FastAPI의 사용 방법에 대해 학습 용도.
  • 다듬어진 포스팅만 작성하려고 하니 글 자체를 작성하지 않게 되버리는 것 같아, 우선 포스팅을 하고 수정 및 계속해서 작성하는 형태로 변경. 실제 글은 영양가가 없을 가능성이 큽니다.
  • 기본적으로 FastAPI 문서 자체를 번역 하는 형태를 취할 예정이고, 구글 번역을 바탕으로 진행할 예정이라 영어에 익숙한 분들은 원문을 보는게 더 좋을 것 같습니다.

0. 코드 실행

이 튜토리얼은 대부분의 기능으로 FastAPI를 사용하는 방법을 보여줍니다.

각 섹션은 점진적으로 이전 섹션을 기반으로 작성되지만 개별 주제로 구성되어 있으므로 특정 API 요구 사항을 해결하기 위해 특정 주제로 직접 이동할 수 있습니다.

또한 향후 참조로 사용할 수 있도록 제작되었습니다.

따라서 돌아와서 필요한 것을 정확히 볼 수 있습니다.

모든 코드 블록은 직접 복사하여 사용할 수 있습니다 (실제로 테스트 된 Python 파일 임).

예제를 실행하려면 코드를 main.py 파일에 복사하고 다음을 사용하여 uvicorn을 시작하십시오.

uvicorn main:app --reload

코드를 작성하거나 복사하고 편집하고 로컬에서 실행하는 것이 좋습니다.

편집기에서 이를 사용하면 FastAPI의 이점, 작성해야하는 코드의 양, 모든 유형 검사, 자동 완성 등을 확인할 수 있습니다.

1. FastAPI 설치

첫 번째 단계는 FastAPI를 설치하는 것입니다.

자습서의 경우 모든 선택적 종속성 및 기능을 사용하여 설치할 수 있습니다.

pip install fastapi[all]

... 여기에는 코드를 실행하는 서버로 사용할 수있는 uvicorn도 포함됩니다.

참고

  • 부분적으로 설치할 수도 있습니다. 애플리케이션을 프로덕션에 배포하려는 경우 다음 작업을 수행 할 수 있습니다.
pip install fastapi
  • 또한 서버로 작동하도록 uvicorn을 설치하십시오.
pip install uvicorn[standard]
  • 사용하려는 각 선택적 종속성에 대해 동일합니다.

2. 고급 사용자 가이드

튜토리얼-사용자 안내서 이후에 읽을 수 있는 고급 사용자 안내서도 있습니다.

고급 사용자 가이드는 이를 기반으로 동일한 개념을 사용하며 몇 가지 추가 기능을 알려줍니다.

그러나 먼저 튜토리얼-사용자 안내서(지금 읽고있는 내용)를 읽어야합니다.

튜토리얼-사용자 안내서 만으로 완전한 애플리케이션을 구축 한 다음,고급 사용자 안내서 의 몇 가지 추가 아이디어를 사용하여 필요에 따라 다양한 방식으로 확장 할 수 있도록 설계되었습니다.

3. 결론

  • 시작은 FastAPI에서 제공 해주는 튜토리얼 사용자 가이드를 보고 구현

· 약 9분
karais89

환경

  • Windows 10
  • Pycharm 2021.1.2
  • Github

포스팅 목적

  • FastAPI의 사용 방법에 대해 학습 용도.
  • 다듬어진 포스팅만 작성하려고 하니 글 자체를 작성하지 않게 되버리는 것 같아, 우선 포스팅을 하고 수정 및 계속해서 작성하는 형태로 변경. 실제 글은 영양가가 없을 가능성이 큽니다.
  • 기본적으로 FastAPI 문서 자체를 번역 하는 형태를 취할 예정이고, 구글 번역을 바탕으로 진행할 예정이라 영어에 익숙한 분들은 원문을 보는게 더 좋을 것 같습니다.

0. Example

from typing import Optional

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
return {"Hello": "World"}

@app.get("/items/{item_id}")
def read_item(item_id: int, q: Optional[str] = None):
return {"item_id": item_id, "q": q}
uvicorn main:app --reload
{"item_id": 5, "q": "somequery"}
  • 다음과 같은 API를 만들었습니다.
    • 경로 //items/{item_id}에서 HTTP 요청을 수신합니다.
    • 두 경로 모두 GET 작업 (HTTP 메서드라고도 함)을 사용합니다.
    • 경로 /items/{item_id}에는 int 여야 하는 경로 매개 변수 item_id가 있습니다.
    • 경로 /items/{item_id}에는 선택적 str 쿼리 매개 변수 q가 있습니다.

1. Example 업그레이드

이제 PUT 요청에서 본문을 수신하도록 main.py 파일을 수정하십시오.

Pydantic 덕분에 표준 Python 유형을 사용하여 본문을 선언하십시오.

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

app = FastAPI()

class Item(BaseModel):
name: str
price: float
is_offer: Optional[bool] = None

@app.get("/")
def read_root():
return {"Hello": "World"}

@app.get("/items/{item_id}")
def read_item(item_id: int, q: Optional[str] = None):
return {"item_id": item_id, "q": q}

@app.put("/items/{item_id}")
def update_item(item_id: int, item: Item):
return {"item_name": item.name, "item_id": item_id}

요약하면 매개 변수, 본문 등의 유형을 함수 매개 변수로 한 번 선언합니다.

표준 최신 Python 유형을 사용하여 수행합니다.

새로운 구문, 특정 라이브러리의 메서드 또는 클래스 등을 배울 필요가 없습니다.

표준 Python 3.6 이상입니다.

예를 들어 int의 경우 :

item_id: int

또는 더 복잡한 Item 모델의 경우 :

item: Item

.. 그 단일 선언으로 다음을 얻을 수 있습니다.

  • 편집기 지원
    • 자동 완성
    • 타입 체크
  • 데이터 유효성
    • 데이터가 유효하지 않은 경우 자동 및 명확한 오류.
    • 깊이 중첩 된 JSON 개체에 대한 유효성 검사.
  • 입력 데이터 변환 : 네트워크에서 Python 데이터 및 유형으로. 읽기 :
    • JSON
    • 경로 매개 변수
    • 쿼리 매개 변수
    • 쿠키
    • 헤더
    • Forms
    • 파일
  • 출력 데이터 변환 : Python 데이터 및 유형에서 네트워크 데이터 (JSON)로 변환 :
    • Python 유형 (str, int, float, bool, list 등)을 변환합니다.
    • datetime 객체.
    • UUID 개체.
    • 데이터베이스 모델
    • 그리고 더 많은 것들
  • 2 개의 대체 사용자 인터페이스를 포함한 자동 대화 형 API 문서
    • Swagger UI.
    • ReDoc.

이전 코드 예제로 돌아가서 FastAPI는 다음을 수행합니다.

  • GETPUT 요청에 대한 경로에 item_id가 있는지 확인합니다.
  • item_idGETPUT 요청에 대해 int 유형인지 확인합니다.
    • 그렇지 않은 경우 클라이언트에 유용하고 명확한 오류가 표시됩니다.
  • GET 요청에 대해 q(http://127.0.0.1:8000/items/foo?q=somequery)라는 선택적 쿼리 매개 변수가 있는지 확인합니다.
    • q 매개 변수는 = None으로 선언되므로 선택 사항입니다.
    • None이 없으면 필요합니다 (PUT의 경우 본문처럼).
  • /items/{item_id}에 대한 PUT 요청의 경우 본문을 JSON으로 읽습니다.
    • str이어야하는 필수 속성 name이 있는지 확인
    • float이어야하는 필수 속성 price이 있는지 확인
    • 선택적인 속성 is_offer가 있는지 확인 (있는 경우 bool이어야 함).
    • 이 모든 것은 깊이 중첩 된 JSON 객체에서도 작동합니다.
  • JSON으로 자동으로 변환합니다.
  • OpenAPI로 모든 것을 자동으로 문서화.
    • 대화 형 문서 시스템.
    • 여러 언어에 대한 자동 클라이언트 코드 생성 시스템.
  • 2 개의 대화 형 문서 웹 인터페이스를 자동으로 제공합니다.

우리는 예제 코드를 통해 모든 것이 어떻게 작동하는지에 대한 아이디어를 얻었습니다.

다음과 같이 줄을 변경하십시오.

return {"item_name": item.name, "item_id": item_id}

에서

... "item_name": item.name ...

으로

... "item_price": item.price ...

... 편집기가 속성을 자동 완성하는 방법과 속성 유형을 확인합니다.

더 많은 기능을 포함하는 완전한 예는 튜토리얼-사용자 가이드를 참조하십시오

스포일러 경고 : 튜토리얼-사용자 가이드에는 다음이 포함됩니다.

  • 헤더, 쿠키, 양식 필드 및 파일과 같은 다른 위치의 매개 변수 선언.
  • 유효성 검사 제약 조건을 maximum_length 또는 regex로 설정하는 방법
  • 매우 강력하고 사용하기 쉬운 의존성 주입 시스템.
  • JWT 토큰 및 HTTP 기본 인증을 사용한 OAuth2 지원을 포함한 보안 및 인증.
  • (Pydantic 덕분에) 깊게 중첩 된 JSON 모델을 선언하기 위한 더 진보 된 (하지만 똑같이 쉬운) 기술.
  • 많은 추가 기능 (Starlette 덕분에)
    • 웹소켓
    • GraphQL
    • requestspytest를 기반으로하는 매우 쉬운 테스트
    • CORS
    • 쿠키세션
    • 조금더 많은 것들

2. 성능

독립적 인 TechEmpower 벤치 마크에 따르면 Uvicorn에서 실행되는 FastAPI 애플리케이션은 사용 가능한 가장 빠른 Python 프레임 워크 중 하나입니다.

이에 대한 자세한 내용은 벤치 마크 섹션을 참조하십시오.

3. 선택적 종속성 패키지

Pydantic에서 사용 :

  • ujson - 더 빠른 JSON "파싱"용.
  • email_validator - 이메일 검증 용.

Starlette에서 사용 :

  • requests - TestClient를 사용하려는 경우 필수입니다.
  • aiofiles - FileResponse 또는 StaticFiles를 사용하려는 경우 필요합니다.
  • jinja2 - 기본 템플릿 구성을 사용하려는 경우 필요합니다.
  • python-multipart - request.form()을 사용하여 "파싱"양식을 지원하려는 경우 필요합니다.
  • itsdangerous - SessionMiddleware 지원에 필요합니다.
  • pyyaml - Starlette의 SchemaGenerator 지원에 필요합니다 (FastAPI에서는 필요하지 않을 수 있음).
  • graphene - GraphQLApp 지원에 필요합니다.
  • ujson - UJSONResponse를 사용하려는 경우 필요합니다.

FastAPI/Starlette에서 사용 :

  • uvicorn - 애플리케이션을 로드하고 제공하는 서버용.
  • orjson - ORJSONResponse를 사용하려는 경우 필수

이 모든 것을 pip install fastapi[all]로 설치할 수 있습니다.

4. 결론

  • FastAPI를 사용하여, 간단하고 빠르게 개발이 가능하다.
    • FastAPI 내부에서 여러가지 도움이 될만한 작업들을 수행한다. (개발자가 신경 쓰지 않아도 된다.)

· 약 4분
karais89

환경

  • Windows 10
  • Pycharm 2021.1.2
  • Github

포스팅 목적

  • FastAPI의 사용 방법에 대해 학습 용도.
  • 다듬어진 포스팅만 작성하려고 하니 글 자체를 작성하지 않게 되버리는 것 같아, 우선 포스팅을 하고 수정 및 계속해서 작성하는 형태로 변경. 실제 글은 영양가가 없을 가능성이 큽니다.
  • 기본적으로 FastAPI 문서 자체를 번역 하는 형태를 취할 예정이고, 구글 번역을 바탕으로 진행할 예정이라 영어에 익숙한 분들은 원문을 보는게 더 좋을 것 같습니다.

0. FastAPI란?

FastAPI는 고성능의 배우기 쉽고, 빠르게 코딩 가능한 프레임 워크이다.

특징

  • 빠른 속도: NodejsGolang과 동등한 매우 높은 성능 (Starlette 및 Pydantic 덕분에). 사용 가능한 가장 빠른 Python 프레임 워크 중 하나입니다.
  • 높은 생산성: 개발 속도가 2배~3배 증가 됨
  • 적은 버그: 개발자의 실수가 40% 감소 됨
  • 직관적: 훌륭한 편집기 지원. 자동 완성. 디버깅 시간 감소 됨
  • 쉬움: 사용하고 배우기 쉽게 설계되었습니다. 문서를 읽는 시간이 단축 됨
  • 짧음: 코드 중복을 최소화합니다. 각 매개 변수 선언의 여러 기능. 더 적은 버그.
  • 견고함: 생산 준비 코드를 가져옵니다. 자동 대화형 설명서 사용.
  • 표준 기반: OpenAPI (이전에는 Swagger라고 함) 및 JSON 스키마를 기반으로 하며 완전히 호환됩니다.

사용 후 느낀 장점

  • 빠른 속도 (실제 측정은 해보지 않았지만 기존 장고나 플라스크를 사용하기 꺼려했던 이유 중 하나)
  • 타입 선언을 어느 정도 강제 한다는 부분
  • 홈페이지의 메뉴얼이 잘 되어 있다 (한글 지원은 좀 아쉽다)
  • 코드 작성 후 자동 문서화 및 쉬운 테스트 가능
  • 파이썬 언어에서 오는 장점 (많은 라이브러리 및 검색의 용이)

결론은 Restful API 작성 용도로 정말 좋은 프레임 워크라는 생각이 들었다.

1. 파이참에서 FastAPI의 설정

  • 가상 환경 설정 등은 제외 - 아래 명령어로 pip 설치 혹은 파이참에서 설치
pip install fastapi
pip install uvicorn[standard]
  • 기본적으로 프로젝트 생성시 fastAPI 관련 설정은 없음
  • Edit Configurations.. 에서 + 버튼으로 python 추가 후 아래 처럼 입력

ide

아래 명령어로도 실행 가능

uvicorn main:app --reload
  • 단 파일명은 main.py 파일

2. Hello World

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
return {"Hello": "World"}

root

docs

redoc

3. 결론

  • 파이썬을 사용하여 간단한 Restful API를 구현하고 싶은 분이라면 FastAPI가 그 대안이 될 수도 있을 것 같다.