Модели запроса и ответа

Развёртывание ИИ в производственной среде с помощью FastAPI

Matt Eckerle

Software and Data Engineering Leader

Структуры запроса и ответа в API

Структура запроса

Данные, отправляемые клиентом в API
Обычно включает:
- HTTP-метод (GET, POST и др.)
- Заголовки
- Параметры запроса
- Тело запроса

http://localhost:8000/users/? [email protected]

:8000: номер порта. FastAPI по умолчанию использует порт 8000.
/users/: путь к конкретному эндпоинту.
?: начало строки параметров запроса.
`[email protected]`: параметр запроса — в данном случае передаётся адрес электронной почты.

Структура ответа

Данные, возвращаемые API клиенту
- JSON-ответ с информацией о пользователе
Обычно включает:
- Код состояния (200 OK, 404 Not Found и др.)
- Заголовки
- Тело ответа (запрошенные данные или результат операции)

HTTP/1.1 200 OK
date: Fri, 18 Oct 2024 12:34:56 GMT
server: uvicorn
content-length: 76
content-type: application/json

{
  "username": "johndoe",
  "email": "[email protected]",
  "age": 30
}

Модель Pydantic

Создание модели User
Использование Pydantic

from pydantic import BaseModel

class User(BaseModel):
    username: str
    email: str
    age: int

Наследуется от BaseModel
Определяет атрибуты с аннотациями типов
Автоматическая валидация на основе типов

Ошибка валидации

from pydantic import ValidationError
try:
    invalid_user = User(username="john_doe", email="[email protected]", 
                        age="thirty")
    print("Invalid User:", invalid_user)
except ValidationError as e:
    print("Validation Error:", e)

Validation Error: 1 validation error for User age
Input should be a valid integer, unable to parse string as an integer 
[type=int_parsing, input_value='thirty', input_type=str]

Использование моделей Pydantic в FastAPI

from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()


class User(BaseModel):
    username: str
    email: str
    age: int


@app.post("/users", response_model=User)

async def create_user(user: User):
    return user

Модель используется как response_model
Модель используется как подсказка типа параметра
Автоматическая валидация запроса
Сериализация/десериализация запроса и ответа
Генерация документации API

Форматы запроса и ответа

curl -X 'POST' \
  'http://localhost:8000/users/' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "john_doe",
  "email": "[email protected]",
  "age": 30
  }'

{
  "username": "john_doe",
  "email": "[email protected]",
  "age": 30
}

Давайте потренируемся!

Развёртывание ИИ в производственной среде с помощью FastAPI