Ves a la documentació
API

OpenAPI

La referència llegible per màquines.

El document

Es serveix sense autenticació a /openapi.json, perquè un generador de clients el necessita per saber com autenticar-se, i exigir una clau per saber-ho seria un cercle.

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

Els esquemes de petició deriven del mateix zod que els valida, de manera que el document no pot descriure cap camp que el servidor rebutjaria. Una especificació escrita a mà és una segona descripció de l'API que es desvia en silenci, i el mode de fallada és un client generat que envia una cosa que el servidor rebutja, cosa que sembla un error del client.