छठा चरण: कोई एपीआई पब्लिश करना

Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं.
जानकारी

इस चरण में, यह तरीका अपनाकर पोर्टल पर एपीआई पब्लिश किया जा सकता है:
1. OpenAPI के बारे में जानकारी देना
2. किसी स्पेसिफ़िकेशन से एपीआई प्रॉक्सी बनाना
3. एपीआई प्रॉडक्ट बनाएं
4. एपीआई को अपने पोर्टल पर पब्लिश करना

पहला चरण: OpenAPI स्पेसिफ़िकेशन बनाना

हर OpenAPI स्पेसिफ़िकेशन, एपीआई के पूरे लाइफ़साइकल के दौरान सही सोर्स के तौर पर काम करता है. एपीआई के लाइफ़साइकल के हर चरण में, डेवलपमेंट से लेकर पब्लिश करने तक, इसी जानकारी का इस्तेमाल किया जाता है.

ओपन एपीआई स्पेसिफ़िकेशन बनाने के लिए:

  1. खास जानकारी पेज को खोलने के लिए, बाईं ओर दिए गए नेविगेशन बार में डेवलप करें > खास जानकारी चुनें.
  2. + खास जानकारी > यूआरएल इंपोर्ट करें पर क्लिक करें.
  3. इंपोर्ट डायलॉग में यह जानकारी डालें:
  4. इंपोर्ट का नाम: helloworld
  5. इंपोर्ट यूआरएल: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

  6. इंपोर्ट करें पर क्लिक करें.

दूसरा चरण: किसी स्पेसिफ़िकेशन के आधार पर एपीआई प्रॉक्सी बनाना

एपीआई के बारे में जानकारी देने वाली OpenAPI स्पेसिफ़िकेशन की मदद से, एपीआई प्रॉक्सी बनाएं.

किसी OpenAPI स्पेसिफ़िकेशन से एपीआई प्रॉक्सी बनाने के लिए:

  1. कार्रवाइयों का मेन्यू दिखाने के लिए, खास जानकारी वाले पेज पर, अपने कर्सर को helloworld स्पेसिफ़िकेशन पर रखें.
  2. खास जानकारी से एपीआई प्रॉक्सी जनरेट करने के लिए, पर क्लिक करें.
    'प्रॉक्सी बनाएं' विज़र्ड खुल गया है. साथ ही, जानकारी वाला पेज, OpenAPI स्पेसिफ़िकेशन में दी गई वैल्यू का इस्तेमाल करके पहले से भरा हुआ है.
  3. Description वाले फ़ील्ड में इस तरह से बदलाव करें: नमस्ते दुनिया के लिए एपीआई प्रॉक्सी.
  4. आगे बढ़ें पर क्लिक करें.
  5. नीतियां पेज पर:

    • सुरक्षा: अनुमति में जाकर, पास करें (अनुमति नहीं है) को चुनें.
    • सुरक्षा: ब्राउज़र में, सीओआरएस हेडर जोड़ें को चुनें .

    'प्रॉक्सी बनाएं' विज़र्ड में, सामान्य नीतियों वाले पेज को चुना गया है. इसमें पास-थ्रू और सीओआरएस हेडर जोड़ें

  6. आगे बढ़ें पर क्लिक करें.

  7. फ़्लो पेज पर पक्का करें कि सभी कार्रवाइयां चुनी गई हैं और आगे बढ़ें पर क्लिक करें.
    प्रॉक्सी फ़्लो बनाएं

  8. वर्चुअल होस्ट पेज पर, पक्का करें कि सभी वर्चुअल होस्ट चुने गए हों. इसके बाद, आगे बढ़ें पर क्लिक करें.

  9. खास जानकारी पेज पर, वैकल्पिक डिप्लॉयमेंट के तहत वह एनवायरमेंट चुनें जिसके लिए आपको डिप्लॉयमेंट करना है.

  10. बनाएं पर क्लिक करें.

खास जानकारी वाले पेज पर, आपको इस बात की पुष्टि दिखेगी कि आपका नया एपीआई प्रॉक्सी बन गया है और टेस्ट एनवायरमेंट में डिप्लॉय कर दिया गया है.

तीसरा चरण: एपीआई प्रॉडक्ट बनाना

ऐसा एपीआई प्रॉडक्ट बनाएं जिसमें वे एपीआई रिसॉर्स हों जिन्हें आपको अपने एपीआई उपभोक्ताओं को दिखाना है.

एपीआई प्रॉडक्ट बनाने के लिए:

  1. एपीआई प्रॉडक्ट पेज खोलने के लिए, बाईं ओर मौजूद नेविगेशन बार में पब्लिश करें > एपीआई प्रॉडक्ट चुनें.
  2. + एपीआई प्रॉडक्ट पर क्लिक करें.
    नया प्रॉडक्ट पेज दिखेगा.
  3. एपीआई प्रॉडक्ट की प्रॉडक्ट की जानकारी डालें.
    ध्यान दें: एपीआई प्रॉडक्ट पब्लिश करने पर, डिसप्ले नेम और जानकारी वाले फ़ील्ड, पोर्टल में डिफ़ॉल्ट रूप से दिखते हैं. चौथा चरण: एपीआई को अपने पोर्टल पर पब्लिश करना सेक्शन में जाकर, वैल्यू में बदलाव किया जा सकता है.
    फ़ील्ड वैल्यू
    नाम सभी को नमस्ते
    डिसप्ले नाम सभी को नमस्ते
    ब्यौरा नमस्ते दुनिया का सिंपल उदाहरण
    एनवायरमेंट वह एनवायरमेंट चुनें जहां एपीआई प्रॉक्सी डिप्लॉय किया गया है.
    ऐक्सेस सार्वजनिक
    ऐक्सेस के अनुरोध अपने-आप स्वीकार करें चालू है
    अनुरोध भेजने की तय सीमा (कोटा) (खाली छोड़ दें)
    अनुमति वाले OAuth स्कोप (खाली छोड़ दें)
  4. एपीआई रिसॉर्स में जाकर, अपने एपीआई प्रॉडक्ट में जोड़ने के लिए एपीआई प्रॉक्सी की पहचान करने के लिए, प्रॉक्सी जोड़ें पर क्लिक करें.
    एपीआई रिसॉर्स जोड़ें डायलॉग दिखता है.
  5. एपीआई प्रॉक्सी (अगर यह पहले से नहीं चुना गया है) पर क्लिक करें और सूची में मॉक-टारगेट-एपीआई चुनें.
  6. जोड़ें पर क्लिक करें.
  7. एपीआई प्रॉडक्ट को सेव करने के लिए, सेव करें पर क्लिक करें.

    Hello World API प्रॉडक्ट के सभी फ़ील्ड सेट दिख रहे हैं

चौथा चरण: एपीआई को अपने पोर्टल पर पब्लिश करें

इस एपीआई को अपने पोर्टल पर पब्लिश करें, ताकि ग्राहक इसके बारे में जान सकें और इसका इस्तेमाल कर सकें.

एपीआई को अपने पोर्टल पर पब्लिश करने के लिए:

  1. अपने पोर्टल में एपीआई पेज पर जाएं:
    1. बाएं नेविगेशन बार में, पब्लिश करें > पोर्टल चुनें.
    2. पोर्टल खोलने के लिए, मेरा पहला पोर्टल लाइन पर क्लिक करें.
    3. एपीआई पेज देखने के लिए, एपीआई कैटलॉग पर क्लिक करें.
  2. + पर क्लिक करें.
  3. कैटलॉग में एपीआई प्रॉडक्ट जोड़ें डायलॉग में नमस्ते दुनिया चुनें और आगे बढ़ें पर क्लिक करें.
  4. एपीआई की जानकारी में जाकर, ये विकल्प कॉन्फ़िगर करें:
    • अपने पोर्टल पर एपीआई पब्लिश करने के लिए, पब्लिश किया गया (कैटलॉग में दिया गया) चुनें.
    • डिसप्ले इमेज के लिए:
      1. इमेज चुनें पर क्लिक करें.
      2. इमेज चुनें डायलॉग में, पहले से मौजूद इमेज की सूची में जाकर home-background.jpg पर क्लिक करें.
      3. चुनें पर क्लिक करें.
      4. इमेज की झलक देखें और चुनें पर क्लिक करें.
    • कैटगरी के लिए, शुरू करें डालें और Enter दबाएं.

    बाकी सभी वैल्यू को उनके डिफ़ॉल्ट पर सेट रहने दें.

  5. एपीआई दस्तावेज़ में, अपने OpenAPI स्पेसिफ़िकेशन के स्नैपशॉट से, एपीआई के रेफ़रंस दस्तावेज़ अपने-आप जनरेट करने के लिए:
    1. OpenAPI दस्तावेज़ चुनें.
    2. दस्तावेज़ चुनें पर क्लिक करें.
    3. मेरी विशेषताएं टैब चुनें (अगर यह पहले से नहीं चुना गया है).
    4. खास जानकारी की सूची से helloworld चुनें.
    5. चुनें पर क्लिक करें.
  6. एपीआई की जानकारी सेव करने के लिए, सेव करें पर क्लिक करें.

    Hello World API के सभी फ़ील्ड के सेट दिख रहे हैं

एपीआई रेफ़रंस दस्तावेज़ देखने के लिए:

  1. लाइव पोर्टल में बदलाव देखने के लिए, लाइव पोर्टल पर क्लिक करें (या अगर यह पहले से किसी दूसरे टैब में खुला है, तो लाइव पोर्टल को रीफ़्रेश करें).
  2. पब्लिश किया गया एपीआई देखने के लिए, सबसे ऊपर नेविगेशन बार में एपीआई पर क्लिक करें.
  3. एपीआई रेफ़रंस दस्तावेज़ देखने के लिए, Hello World कार्ड पर क्लिक करें. अपने एपीआई को आज़माएं!

इस एपीआई पैनल को आज़माएं के साथ, मॉक टारगेट एपीआई पब्लिश किया गया


बधाई हो! आपने ट्यूटोरियल पूरा कर लिया है. अधिक जानने के लिए तैयार हैं? अपना इंटिग्रेटेड पोर्टल बनाएं पर जाएं.