見出し画像

FASTAPIのインストール方法と基本的な使い方

やかん



1. インストール方法

1.1 Pythonのインストール

FASTAPIを使用するにはPythonが必要です。まず、Pythonがインストールされていることを確認してください。

1.2 仮想環境の作成（任意）

プロジェクトごとに依存関係を分離するために、仮想環境を作成することをお勧めします。

python -m venv env
source env/bin/activate  # Unix系OS
.\env\Scripts\activate  # Windows

1.3 FASTAPIとUvicornのインストール

FASTAPI自体と、開発サーバーとして使用するUvicornをインストールします。

pip install fastapi uvicorn

2. 基本的な使い方

2.1 プロジェクトディレクトリの作成

mkdir myfastapiapp
cd myfastapiapp

2.2 メインファイルの作成

`main.py`というファイルを作成し、以下のコードを追加します。

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: str = None):
    return {"item_id": item_id, "q": q}

2.3 サーバーの起動

uvicorn main:app --reload

これにより、開発サーバーが起動し、`http://127.0.0.1:8000`でアクセスできるようになります。

3. 使い方の詳細

3.1 ルーティング

`@app.get`デコレーターを使用してエンドポイントを定義します。POSTリクエストやPUTリクエストなど、他のHTTPメソッドも同様にデコレーターを使用します（`@app.post`、`@app.put`など）。

3.2 パスパラメータ

ルートのパスに動的なパラメータを含めることができます。例: `/items/{item_id}`。

3.3 クエリパラメータ

URLに含まれるクエリパラメータも受け取れます。例: `q: str = None`。

3.4 リクエストボディ

`pydantic`モデルを使用してリクエストボディを定義します。

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

@app.post("/items/")
def create_item(item: Item):
    return item

4. FASTAPIの機能

4.1 自動生成されるAPIドキュメント

4.2 入力データのバリデーション

`pydantic`を使用して、リクエストの入力データを自動的にバリデーションします。

4.3 非同期サポート

`async` / `await`構文を使用して、非同期プログラミングをサポートします。

4.4 依存性注入

`Depends`を使用して、依存関係の注入を簡単に行えます。

from fastapi import Depends

def common_parameters(q: str = None, skip: int = 0, limit: int = 100):
    return {"q": q, "skip": skip, "limit": limit}

@app.get("/items/")
def read_items(commons: dict = Depends(common_parameters)):
    return commons

5. 具体的な用途と使用例

5.1 Web APIの開発

使用例：TodoリストAPI

目的: シンプルなTodoリスト管理アプリのバックエンドAPIを構築します。ユーザーはタスクを追加、更新、削除、表示できます。

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
from typing import List

app = FastAPI()

class TodoItem(BaseModel):
    id: int
    title: str
    description: str = None
    completed: bool = False

todo_list = []

@app.post("/todos/", response_model=TodoItem)
def create_todo_item(item: TodoItem):
    todo_list.append(item)
    return item

@app.get("/todos/", response_model=List[TodoItem])
def get_todo_items():
    return todo_list

@app.get("/todos/{item_id}", response_model=TodoItem)
def get_todo_item(item_id: int):
    for item in todo_list:
        if item.id == item_id:
            return item
    raise HTTPException(status_code=404, detail="Item not found")

@app.put("/todos/{item_id}", response_model=TodoItem)
def update_todo_item(item_id: int, updated_item: TodoItem):
    for index, item in enumerate(todo_list):
        if item.id == item_id:
            todo_list[index] = updated_item
            return updated_item
    raise HTTPException(status_code=404, detail="Item not found")

@app.delete("/todos/{item_id}", response_model=TodoItem)
def delete_todo_item(item_id: int):
    for index, item in enumerate(todo_list):
        if item.id == item_id:
            return todo_list.pop(index)
    raise HTTPException(status_code=404, detail="Item not found")

5.2 ユーザー認証と認可

使用例：JWTを使ったユーザー認証

目的: ユーザーがログインし、JWTトークンを使って認証されたAPIリクエストを行うシステムを構築します。

from fastapi import FastAPI, Depends, HTTPException
from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
from pydantic import BaseModel
from datetime import datetime, timedelta
from jose import JWTError, jwt
from typing import Optional

app = FastAPI()

SECRET_KEY = "your_secret_key"
ALGORITHM = "HS256"
ACCESS_TOKEN_EXPIRE_MINUTES = 30

fake_users_db = {
    "user1": {
        "username": "user1",
        "full_name": "User One",
        "email": "user1@example.com",
        "hashed_password": "fakehashedsecret",
        "disabled": False,
    }
}

class Token(BaseModel):
    access_token: str
    token_type: str

class TokenData(BaseModel):
    username: Optional[str] = None

class User(BaseModel):
    username: str
    email: Optional[str] = None
    full_name: Optional[str] = None
    disabled: Optional[bool] = None

class UserInDB(User):
    hashed_password: str

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

def verify_password(plain_password, hashed_password):
    return plain_password == hashed_password

def get_user(db, username: str):
    if username in db:
        user_dict = db[username]
        return UserInDB(**user_dict)

def authenticate_user(fake_db, username: str, password: str):
    user = get_user(fake_db, username)
    if not user:
        return False
    if not verify_password(password, user.hashed_password):
        return False
    return user

def create_access_token(data: dict, expires_delta: Optional[timedelta] = None):
    to_encode = data.copy()
    if expires_delta:
        expire = datetime.utcnow() + expires_delta
    else:
        expire = datetime.utcnow() + timedelta(minutes=15)
    to_encode.update({"exp": expire})
    encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
    return encoded_jwt

@app.post("/token", response_model=Token)
async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
    user = authenticate_user(fake_users_db, form_data.username, form_data.password)
    if not user:
        raise HTTPException(
            status_code=401,
            detail="Incorrect username or password",
            headers={"WWW-Authenticate": "Bearer"},
        )
    access_token_expires = timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES)
    access_token = create_access_token(
        data={"sub": user.username}, expires_delta=access_token_expires
    )
    return {"access_token": access_token, "token_type": "bearer"}

@app.get("/users/me", response_model=User)
async def read_users_me(token: str = Depends(oauth2_scheme)):
    credentials_exception = HTTPException(
        status_code=401,
        detail="Could not validate credentials",
        headers={"WWW-Authenticate": "Bearer"},
    )
    try:
        payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
        username: str = payload.get("sub")
        if username is None:
            raise credentials_exception

いいなと思ったら応援しよう！