Przejdź do dokumentacji
API

OpenAPI

Dokumentacja czytelna maszynowo.

Dokument

Serwowany bez uwierzytelniania pod /openapi.json, ponieważ generator klienta potrzebuje go, by dowiedzieć się, jak się uwierzytelnić, a wymaganie klucza po to, by się tego dowiedzieć, byłoby błędnym kołem.

Wygeneruj klienta
curl -s https://api.openemail.uk/openapi.json -o openemail.jsonopenapi-generator generate -i openemail.json -g python -o ./client

Schematy żądań są wywodzone z tego samego zod, który je waliduje, więc dokument nie może opisywać pola, które serwer by odrzucił. Ręcznie pisana specyfikacja jest drugim opisem API, który po cichu się rozjeżdża, a trybem awarii jest wygenerowany klient wysyłający coś, co serwer odrzuca — co wygląda na błąd klienta.