तेज और आसान एपीआई एकीकरण के लिए संरचित प्रलेखन की आवश्यकता है। हम OpenAPI 3 विनिर्देश का उपयोग करें। 0 + (पूर्व में स्वैगर), जो आपको एसडीके को कोड, परीक्षण और निर्यात करने की क्षमता के साथ एकल मानकीकृत प्रारूप में सभी एपीआई विधियों, मापदंडों और मॉडल का वर्णन करने की अनुमति देता है।
यह डेवलपर्स के लिए प्रवेश सीमा को कम करता है, एकीकरण को गति देता है, और अधूरा या पुराना इंटरफ़ेस विवरण से जुड़ी त्रुटियों को समाप्त करता है।
OpenAPI/स्वैगर क्या देता है
| अवसर | फायदे |
|---|---|
| ऑनलाइन प्रलेखन | ब्राउज़र में एपीआई का परीक्षण करने की क्षमता के साथ स्वैगर यूआई |
| एसडीके पीढ़ी | विभिन्न भाषाओं में ग्राहक पुस्तकालयों का स्वचालित नि |
| मानक द्वारा संरचना | सभी समापन बिंदुओं, पैरामीटर, प्रतिक्रियाओं, त्रुटियों और प्राधिकरण का वर्णन |
| मशीन की पढ़ाई | API को CI/CD से मान्य, पार्स्ड, निर्यात और कनेक्ट किया जा सकता है |
| प्रासंगिकता | जब एपीआई बदलता है तो प्रलेखन स्वचालित रूप से अद्यतन किया जा |
इसे कैसे लागू किया जाता है
OpenAPI 3 प्रारूप में API विवरण. 0 (.yaml या। json)
पोस्टमैन संग्रह और एसडीके (cURL, JS, PHP, पायथन, जावा, गो) उत्पन्न करने की क्षमता
प्राधिकरण समर्थन: API कुंजी, JWT, OAuth2
नेत्रहीन उपलब्ध प्रश्न और संभावित प्रतिक्रियाएँ
प्रलेखन से सीधे एपीआई परीक्षण (स्वैगर यूआई/रेडोक)
डेवलपर लाभ
संरचना के मैनुअल पार्सिंग के बिना त्वरित कनेक्शन
आईडीई और कोड जनरेटर समर्थन (स्वैगर कोडेजन, ओपनएपीआई जनरेटर)
प्रलेखन हमेशा वर्तमान एपीआई से मेल खाता है
भागीदारों और इंटीग्रेटर्स को स्थानांतरण के लिए सुवि
बेहतर DX (डेवलपर अनुभव) और कार्यान्वयन गति
जहाँ विशेष रूप से महत्वपूर्ण
ओपन या पब्लिक एपीआई प्रोजेक्ट्स
एपीआई-पहले दृष्टिकोण का अभ्यास करने वाली टीमें
बाहरी एकीकरण और भागीदार कनेक्शन के साथ प्लेटफा
मोबाइल और फ्रंट-एंड एप्लिकेशन जो बैकेंड एपीआई के साथ काम करते हैं
OpenAPI एक आधुनिक API विवरण भाषा है, और स्वैगर इसका उपयोगकर्ता के अनुकूल इंटरफ़ेस है। आपको पारदर्शी दस्तावेज, तेजी से एसडीके जनरेशन और आपके सिस्टम से जुड़ ने वाले सभी लोगों के लिए अधिकतम सुविधा मिलती है।