ओपनएपीआई

फ्री यूज़ बाइबल एपीआई एक ओपनएपीआई 3.1 दस्तावेज़ प्रकाशित करता है जो इस संदर्भ में प्रत्येक एंडपॉइंट का वर्णन करता है, साथ ही इसके पैरामीटर और प्रतिक्रिया संरचनाओं का भी।

GET https://bible.helloao.org/openapi.json

आप इस दस्तावेज़ का उपयोग निम्न कार्यों के लिए कर सकते हैं:

• एक ऐसी भाषा के लिए क्लाइंट लाइब्रेरी बनाएं जिसके लिए हमारे पास SDK उपलब्ध नहीं है।
• API को Postman , Insomnia या Swagger UI जैसे टूल में इम्पोर्ट करें ताकि आप एंडपॉइंट्स का पता लगा सकें।
• प्रकाशित स्कीमाओं के आधार पर API प्रतिक्रियाओं का सत्यापन करें।

ग्राहक उत्पन्न करना

किसी भी OpenAPI-संगत कोड जनरेटर का उपयोग क्लाइंट उत्पन्न करने के लिए किया जा सकता है। उदाहरण के लिए, OpenAPI जनरेटर दर्जनों भाषाओं का समर्थन करता है।

# पायथन
npx @openapitools/openapi-generator-cli generate \
    -i https://bible.helloao.org/openapi.json \
    -g python \
    -o ./free-use-bible-api-python

# सी#
npx @openapitools/openapi-generator-cli generate \
    -i https://bible.helloao.org/openapi.json \
    -g csharp \
    -o ./free-use-bible-api-csharp

टाइपस्क्रिप्ट के लिए, आप @hey-api/openapi-ts उपयोग कर सकते हैं:

npx @hey-api/openapi-ts \
    -i https://bible.helloao.org/openapi.json \
    -o ./src/client

संचालन

ओपनएपीआई दस्तावेज़ में प्रत्येक एंडपॉइंट में operationId होता है, जिसका उपयोग अधिकांश जनरेटर जनरेटेड क्लाइंट में मेथड नाम के रूप में करते हैं। उदाहरण के लिए:

सभी कार्यों की पूरी सूची के लिए ओपनएपीआई दस्तावेज़ देखें।