Ga direct naar de documentatie
API

OpenAPI

De machineleesbare referentie.

Het document

Wordt zonder authenticatie geserveerd op /openapi.json, omdat een clientgenerator het nodig heeft om te weten hoe hij moet authenticeren, en een sleutel eisen om dat te leren zou een cirkel zijn.

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

De verzoekschema's zijn afgeleid van dezelfde zod die ze valideert, dus het document kan geen veld beschrijven dat de server zou afwijzen. Een handgeschreven specificatie is een tweede beschrijving van de API die stilletjes uit de pas loopt, en het faalscenario is een gegenereerde client die iets stuurt wat de server weigert, wat eruitziet als een bug in de client.