Zur Dokumentation springen
API

OpenAPI

Die maschinenlesbare Referenz.

Das Dokument

Unauthentifiziert unter /openapi.json ausgeliefert, weil ein Client-Generator es braucht, um zu wissen, wie authentifiziert wird, und einen Schlüssel dafür zu verlangen wäre ein Zirkelschluss.

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

Die Request-Schemas werden aus demselben zod abgeleitet, das sie validiert, sodass das Dokument kein Feld beschreiben kann, das der Server ablehnen würde. Eine handgeschriebene Spezifikation ist eine zweite Beschreibung der API, die stillschweigend auseinanderdriftet, und der Fehlerfall ist ein generierter Client, der etwas sendet, das der Server ablehnt – was wie ein Fehler des Clients aussieht.