Перейти к документации
API

OpenAPI

Машиночитаемый справочник.

Документ

Отдаётся без аутентификации по адресу /openapi.json, потому что генератору клиента он нужен, чтобы узнать, как аутентифицироваться, а требовать ключ для того, чтобы это узнать, было бы замкнутым кругом.

Сгенерировать клиент
curl -s https://api.openemail.uk/openapi.json -o openemail.jsonopenapi-generator generate -i openemail.json -g python -o ./client

Схемы запросов выводятся из того же zod, который их валидирует, поэтому документ не может описать поле, которое сервер отверг бы. Написанная вручную спецификация — это второе описание API, которое молча расходится с реальностью, и заканчивается это сгенерированным клиентом, отправляющим то, что сервер отклоняет, и выглядит это как ошибка клиента.