ドキュメント本文へスキップ
API

OpenAPI

機械可読なリファレンスです。

このドキュメント

/openapi.json で認証なしに配信しています。クライアントジェネレーターは認証方法を知るためにこのドキュメントを必要とし、それを知るためにキーを要求するのは堂々巡りだからです。

クライアントを生成する
curl -s https://api.openemail.uk/openapi.json -o openemail.jsonopenapi-generator generate -i openemail.json -g python -o ./client

リクエストスキーマは、それらを検証しているのと同じ zod から生成されるので、このドキュメントがサーバーの拒否するフィールドを記述することはありえません。手書きの仕様は API についての 2 つ目の記述であり、静かに乖離します。その失敗の形は、生成されたクライアントがサーバーの拒否するものを送ることであり、クライアント側のバグに見えてしまいます。