Что дальше#

После быстрого старта не нужно читать документацию подряд. Найдите свою задачу в таблице и переходите к соответствующему разделу.

Задача

Куда идти

Пройти один SDK от входа до отправки письма

Разбор на примере

Объявить параметры, заголовки или тело запроса

Запросы

Разобрать успешный ответ или ошибку API

Ответы

Добавить ключ, токен, cookie или вход по паролю

Авторизация

Выбрать HTTPX, Requests или curl_cffi

HTTP-интеграции

Работать со страницами через Playwright или Pydoll

Браузерный SDK

Подключить Pydantic, msgspec, dataclass, HTML или XML

Модели и документы

Собрать несколько сервисов в один SDK

Мультисервисный SDK

Найти точный класс, аргумент или тип

Справочник API

Если API уже описан схемой#

Для OpenAPI используйте генератор OpenAPI. Он создаёт Python-пакет SDK из схемы и сохраняет типы запросов и ответов.

Для AsyncAPI и WebSocket начните с руководства по WebSocket. Там показаны генерация пакета, подключение клиента и типизированные сообщения.

Документация для LLM#

Сборка сайта создаёт два текстовых файла из тех же страниц:

  • llms.txt содержит краткое описание проекта и ссылки на страницы;

  • llms-full.txt содержит полный текст документации в одном файле.

Выбор зависит от инструмента.

Передайте помощнику llms.txt, если он умеет открывать ссылки: так в контекст попадут только нужные страницы. llms-full.txt подходит для локального поиска или инструмента, который не может переходить по ссылкам. Оба файла обновляются при каждой сборке сайта, поэтому отдельную копию документации поддерживать не нужно.

Для точной сигнатуры после объясняющей страницы откройте справочник API. Он отделяет публичные имена от внутренних деталей реализации.

Дальше#