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

Apigee Edge से जुड़े दस्तावेज़ देखे जा रहे हैं.
Apigee X से जुड़े दस्तावेज़ पर जाएं. info

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

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

हर 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. ब्यौरा फ़ील्ड में इस तरह बदलाव करें: API proxy for hello world.
  4. आगे बढ़ें पर क्लिक करें.

  5. नीतियां पेज पर:

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

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

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

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

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

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

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

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

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

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

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

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

    नमस्ते API प्रॉडक्ट, जिसमें सभी फ़ील्ड सेट किए गए हैं

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

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

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

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

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

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

    सभी फ़ील्ड सेट करने वाला नमस्ते API

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

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

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

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