दस्तावेज़ पर जाएँ
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 का दूसरा विवरण होती है जो चुपचाप खिसकता रहता है, और उसकी विफलता यह होती है कि जनरेट किया गया क्लाइंट कुछ ऐसा भेजता है जिसे सर्वर मना करता है — और वह क्लाइंट की बग जैसा दिखता है।