Fork me on GitHub

FastAPI and Python

Полезные ссылки

Установка FastAPI

pip install wheel -U
pip install uvicorn fastapi pydantic 

OpenAPI

FastAPI генерирует «схему» из API с помощью стандарта OpenAPI.

структура описание
Схема (schema) определение или описание чего-либо. Не код, отвечающий за реализацию, а просто абстрактное описание.
API-схема В этом случае OpenAPI — это спецификация, которая предписывает, как именно определять схему API. Определение включает пути, возможные принимаемые параметры и так далее.
Схема данных Понятие «схема» может также указывать на форму некоторых данных: например, JSON-содержимое. В этом случае тут будут указываться JSON-атрибуты, использованные типы данных и другое.
OpenAPI и JSON Schema OpenAPI определяет схему API для созданного API. А она, в свою очередь, включает определения отправленных или полученных через API данных с помощью JSON — стандарта схем данных JSON.

FastAPI автоматически генерирует JSON-схему с описаниями API.

Их можно увидеть прямо на сайте: http://127.0.0.1:8000/openapi.json

При создании API «путь» — это основной способ разделения «concerns» и «resources».

Операция здесь — это один из HTTP-методов:

  • POST
  • GET
  • PUT
  • DELETE
  • OPTIONS
  • HEAD
  • PATCH
  • TRACE

В протоколе HTTP с каждым путем можно взаимодействовать с помощью одного из таких методов.

При создании API обычно эти методы выполняют определенное действие:

  • POST — создает данные
  • GET — читает данные
  • PUT — обновляет данные
  • DELETE — удаляет данные

В OpenAPI каждый из таких методов называется operations.

social