Expand description
§kodik-api-client
Асинхронная типизированная библиотека для публичного Kodik API. Транспорт построен на Hyper + Rustls, выполнение — на Tokio, JSON разбирается simd-json, структуры реализуют Serde, а исходящие запросы ограничиваются governor. Ключ API передаётся только при создании клиента; библиотека не записывает и не логирует его.
§Быстрый старт
use kodik_api::{ContentType, Filters, KodikClient, SearchQuery};
let client = KodikClient::new(std::env::var("KODIK_API_TOKEN")?)?;
let query = SearchQuery {
title: Some("Avatar".into()),
filters: Filters::default().with_types([ContentType::ForeignMovie]),
..Default::default()
};
let response = client.search(query).await?;
for material in response.results {
println!("{} — {}", material.id, material.title);
}Метод KodikClient::list возвращает одну страницу. Сохраните next_page,
извлеките из неё курсор KodikClient::next_cursor и передайте его в
ListQuery::next следующего запроса. Полное описание входных параметров,
методов и моделей находится в docs/API.md.
Structs§
- Collection
Response - Универсальная оболочка ответов справочников: годы, жанры, страны, качества и озвучки.
- Countries
Query - Запрос к
/countries. - Episode
Data - Данные одной серии при
with_episodes_data=true. - Filters
- Общие фильтры материалов, доступные в
/years,/genres,/countries,/qualities/v2,/translations/v2,/listи/search. - Genres
Query - Запрос к
/genres. - Kodik
Client - Многопоточно-безопасный клиент Kodik API.
- Kodik
Client Builder - Построитель
KodikClient. - Label
Count - Строка ресурсов
/genres,/countriesи/qualities/v2. - List
Query - Запрос к
/list. - List
Response - Страница результатов
/list. - Material
- Материал: фильм, сериал, мультфильм, аниме или иной результат Kodik.
- Material
Data - Дополнительные сведения о материале из КиноПоиска, Shikimori и MyDramaList.
- Qualities
Query - Запрос к
/qualities/v2. - Search
Query - Параметры точного и нечёткого поиска
/search. - Search
Response - Ответ ресурса
/search. - Season
- Сезон сериала.
- Translation
- Привязанная к материалу озвучка или субтитры.
- Translation
Count - Строка ресурса
/translations/v2. - Translations
Query - Запрос к
/translations/v2. - Year
Count - Строка ресурса
/years. - Years
Query - Запрос к
/years.
Enums§
- Blocked
Season - Блокировка одного сезона.
- Blocked
Seasons - Описание блокировок сериалов. Kodik может вернуть строку
"all"либо карту сезонов. - Content
Type - Тип материала, который Kodik принимает в параметре
types. - Episode
- Эпизод в кратком или расширенном виде.
- Error
- Ошибка, возникшая при подготовке или выполнении запроса к Kodik API.
- Genre
Source - Типы списка жанров, который должен вернуть
/genres. - Label
Sort - Сортировка строкового справочника: стран, жанров, качеств и озвучек.
- List
Sort - Поле сортировки
/list. - Request
Method - HTTP-способ передачи параметров к Kodik API.
- Required
Field - Поле внешнего идентификатора, требуемое параметрами
has_fieldиhas_field_and. - Sort
Order - Направление сортировки
/list. - Translation
Type - Тип перевода в Kodik.
- Year
Sort - Сортировка списка лет.
Constants§
- DEFAULT_
BASE_ URL - Адрес публичного Kodik API по умолчанию.
- DEFAULT_
MAX_ RESPONSE_ BODY_ BYTES - Максимальное число байтов, которые клиент прочитает из одного ответа.
- DEFAULT_
REQUEST_ TIMEOUT - Максимальная продолжительность одного HTTP-обмена после прохождения rate limiter.