Kalo te dokumentacioni
API

OpenAPI

Referenca e lexueshme nga makina.

Dokumenti

Shërbehet pa vërtetim te /openapi.json, sepse një gjenerues klientësh ka nevojë për të që të dijë si të vërtetohet, dhe kërkimi i një çelësi për ta mësuar këtë do të ishte rreth vicioz.

Gjeneroni një klient
curl -s https://api.openemail.uk/openapi.json -o openemail.jsonopenapi-generator generate -i openemail.json -g python -o ./client

Skemat e kërkesave rrjedhin nga i njëjti zod që i validon ato, ndaj dokumenti nuk mund të përshkruajë një fushë që serveri do ta refuzonte. Një specifikim i shkruar me dorë është një përshkrim i dytë i API-së që largohet prej saj në heshtje, dhe mënyra si dështon është një klient i gjeneruar që dërgon diçka që serveri e refuzon — gjë që duket si defekt i klientit.