किसी OpenAPI विवरण से एक API प्रॉक्सी बनाएं | Apigee Edge

इस ट्यूटोरियल में, आपको OpenAPI की मदद से Edge API प्रॉक्सी बनाने का तरीका बताया जाएगा Apigee Edge मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करने वाली जानकारी. जब एपीआई प्रॉक्सी को एचटीटीपी क्लाइंट, जैसे कि cURL, एपीआई प्रॉक्सी अनुरोध को Apigee मॉक टारगेट को भेजता है सेवा.

Open API Initiative के बारे में जानकारी

"Open API Initiative (OAI) का फ़ोकस इन चीज़ों पर है स्वैगर के आधार पर एक वेंडर न्यूट्रल एपीआई ब्यौरा फ़ॉर्मैट बनाना, उसे बेहतर बनाना, और उसका प्रमोशन करना स्पेसिफ़िकेशन." Open API पहल के बारे में ज़्यादा जानकारी के लिए, https://openapis.org पर जाएं.

RESTful API के बारे में जानकारी देने के लिए, OpenAPI की खास बातें स्टैंडर्ड फ़ॉर्मैट का इस्तेमाल करती है. OpenAPI स्पेसिफ़िकेशन को मशीन से पढ़ा जा सकता है, लेकिन यह JSON या YAML फ़ॉर्मैट में लिखा गया है इन्हें पढ़ना और समझना आसान होता है. इस स्पेसिफ़िकेशन में ऐसे एलिमेंट के बारे में बताया गया है एपीआई अपने बेस पाथ, पाथ और क्रियाओं, हेडर, क्वेरी पैरामीटर, ऑपरेशन, कॉन्टेंट टाइप, जवाब की जानकारी, और बहुत कुछ. इसके अलावा, OpenAPI के स्पेसिफ़िकेशन का इस्तेमाल, आम तौर पर API दस्तावेज़ जनरेट करें.

Apigee मॉक टारगेट सेवा के बारे में जानकारी

इस ट्यूटोरियल में इस्तेमाल की गई, Apigee मॉक टारगेट सेवा को Apigee और रिटर्न में होस्ट किया जाता है आसान डेटा. इसके लिए किसी एपीआई पासकोड या ऐक्सेस टोकन की ज़रूरत नहीं होती. असल में, इसे वेब से ऐक्सेस किया जा सकता है ब्राउज़र खोलें. इसे आज़माने के लिए, इस पर क्लिक करें:

http://mocktarget.apigee.net

टारगेट सेवा, अभिवादन Hello, guest! दिखाती है

मॉक टारगेट सेवा के साथ काम करने वाले एपीआई के पूरे सेट के बारे में जानकारी के लिए, फ़ॉलो किया जा रहा है:

http://mocktarget.apigee.net/help

आपको इनकी ज़रूरत होगी

Apigee Edge खाता. अगर आपका खाता नहीं है, तो नीचे दिए गए निर्देशों का पालन करके साइन अप करें Apigee Edge बनाना जोड़ें.
OpenAPI की खास बातें. इस ट्यूटोरियल में, mocktarget.yaml का इस्तेमाल किया जाएगा OpenAPI की खास बातें, जो Apigee के मॉक टारगेट के बारे में बताती हैं सेवा, http://mocktarget.apigee.net. ज़्यादा जानकारी के लिए, यह देखें https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi.
एपीआई कॉल करने के लिए आपकी मशीन पर cURL इंस्टॉल किया गया है कमांड लाइन से; या वेब ब्राउज़र का इस्तेमाल करें.

एपीआई प्रॉक्सी बनाना

Edge

Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, OpenAPI स्पेसिफ़िकेशन से एपीआई प्रॉक्सी बनाने के लिए:

https://apigee.com/edge में साइन इन करें.
मुख्य विंडो में, एपीआई प्रॉक्सी पर क्लिक करें.
इसके अलावा, डेवलप करें > एपीआई प्रॉक्सी पर क्लिक करें.
+ प्रॉक्सी पर क्लिक करें.
प्रॉक्सी बनाएं विज़र्ड में, रिवर्स प्रॉक्सी (सबसे सामान्य) टेम्प्लेट के लिए OpenAPI विशिष्टता का उपयोग करें पर क्लिक करें.
यूआरएल से इंपोर्ट करें पर क्लिक करके, नीचे दी गई जानकारी डालें:
- OpenAPI का खास यूआरएल: यूआरएल फ़ील्ड में OpenAPI की खास जानकारी के लिए, GitHub पर रॉ कॉन्टेंट का पाथ:
```
https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
```
- खास जानकारी का नाम: OpenAPI की खास बातों का नाम, जैसे कि मॉक टारगेट.
  इस नाम का इस्तेमाल, spec Store में OpenAPI स्पेसिफ़िकेशन को स्टोर करने के लिए किया जाता है. अपनी खास जानकारी को मैनेज करना देखें.

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

'प्रॉक्सी बनाएं' विज़र्ड में, ज़्यादा जानकारी वाला पेज दिखेगा. फ़ील्ड में जानकारी अपने-आप भरी हुई है OpenAPI स्पेसिफ़िकेशन में तय की गई वैल्यू का इस्तेमाल करके, जैसा कि यहां दिखाया गया है

नीचे दी गई टेबल में, उन डिफ़ॉल्ट वैल्यू के बारे में बताया गया है जो इनका इस्तेमाल करके पहले से भरी हुई हैं में दी गई प्रॉपर्टी शामिल हैं. OpenAPI की खास बातों का एक हिस्सा इस्तेमाल की गई प्रॉपर्टी की जानकारी, टेबल में दी गई है.

फ़ील्ड	ब्यौरा	डिफ़ॉल्ट
नाम	एपीआई प्रॉक्सी का नाम. उदाहरण के लिए: `Mock-Target-API`.	OpenAPI स्पेसिफ़िकेशन से जुड़ी `title` प्रॉपर्टी को स्पेस के साथ बदला गया डैश के ज़रिए
बेस पाथ	पाथ कॉम्पोनेंट, जो संगठन में इस एपीआई प्रॉक्सी की खास तौर पर पहचान करता है. इस एपीआई प्रॉक्सी के सार्वजनिक तौर पर दिखने वाले यूआरएल में आपके संगठन का नाम, वातावरण, जहां यह एपीआई प्रॉक्सी डिप्लॉय किया जाता है और यह बेस पाथ. इसके लिए उदाहरण: `http://myorg-test.apigee.net/mock-target-api`	नाम वाले फ़ील्ड के कॉन्टेंट को सभी लोअर केस में बदला गया
जानकारी	एपीआई प्रॉक्सी की जानकारी.	OpenAPI की खास बातों से मिली `description` प्रॉपर्टी
टारगेट (मौजूदा एपीआई)	इस एपीआई प्रॉक्सी की ओर से टारगेट यूआरएल का अनुरोध किया गया. ऐसा कोई भी यूआरएल जिसे यहां से ऐक्सेस किया जा सकता है तो ओपन इंटरनेट का इस्तेमाल किया जा सकता है. जैसे: `http://mocktarget.apigee.net` अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है	OpenAPI की खास बातों से मिली `servers` प्रॉपर्टी

नीचे दिए गए ओपनएपीआई स्पेसिफ़िकेशन का एक हिस्सा है जो ऐसी प्रॉपर्टी जिनका इस्तेमाल फ़ील्ड में अपने-आप जानकारी भरने के लिए किया जाता है.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
...
servers:
  - url: http://mocktarget.apigee.net
  - url: https://mocktarget.apigee.net
...

ब्यौरा फ़ील्ड में इस तरह बदलाव करें: API proxy for the Apigee mock target service endpoint.
आगे बढ़ें पर क्लिक करें.
सामान्य नीतियां पेज पर, 'सुरक्षा: अनुमति देना' में जाकर पक्का करें कि पास थ्रू (अनुमति नहीं है) को चुना गया है. इसके बाद, आगे बढ़ें पर क्लिक करें:
फ़्लो पेज पर, पक्का करें कि सभी कार्रवाइयां चुनी गई हैं.
अहम जानकारी: कंडिशनल फ़्लो अपने-आप जनरेट होते हैं OpenAPI में, paths ऑब्जेक्ट के अंदर तय की गई कार्रवाइयां खास जानकारी. कंडिशनल फ़्लो, Edge को बताती हैं कि "जब आपको यह दिखे, तो इस लॉजिक का इस्तेमाल करें." उदाहरण के लिए, जब एपीआई कॉल, /xml संसाधन (शर्त) पर एक जीईटी होता है, रिस्पॉन्स को JSON में बदलें (कंडिशनल फ़्लो से जुड़ी नीति की मदद से). सिर्फ़ हर लेन-देन के लिए एक फ़्लो एक्ज़ीक्यूट होता है—पहला फ़्लो जिसकी शर्त का आकलन होता है सही है.
आगे बढ़ें पर क्लिक करें.
वर्चुअल होस्ट पेज पर, डिफ़ॉल्ट और सुरक्षित चुनें. इसके बाद, आगे बढ़ें पर टैप करें.
खास जानकारी पेज पर, पक्का करें कि टेस्ट एनवायरमेंट वैकल्पिक डिप्लॉयमेंट में चुना गया हो और बनाएं और deploy:

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

क्लासिक Edge (प्राइवेट क्लाउड)

क्लासिक एज यूआई का इस्तेमाल करके, OpenAPI स्पेसिफ़िकेशन से एपीआई प्रॉक्सी बनाने के लिए:

https://apigee.com/edge में साइन इन करें.
मुख्य विंडो में, एपीआई प्रॉक्सी पर क्लिक करें.
इसके अलावा, डेवलप करें > एपीआई प्रॉक्सी पर क्लिक करें.
+ प्रॉक्सी पर क्लिक करें.
'प्रॉक्सी बनाएं' विज़र्ड में, रिवर्स प्रॉक्सी (सबसे सामान्य) चुनें और OpenAPI का इस्तेमाल करें पर क्लिक करें.
यूआरएल से इंपोर्ट करें पर क्लिक करें और OpenAPI के स्पेसिफ़िकेशन के लिए कोई नाम डालें. इसके बाद, OpenAPI के लिए, GitHub पर रॉ कॉन्टेंट का पाथ डालें यूआरएल फ़ील्ड में दी गई खास जानकारी:

https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml
चुनें पर क्लिक करें.

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

'प्रॉक्सी बनाएं' विज़र्ड में, ज़्यादा जानकारी वाला पेज दिखेगा. फ़ील्ड में जानकारी अपने-आप भरी हुई है OpenAPI स्पेसिफ़िकेशन में तय की गई वैल्यू का इस्तेमाल करके, जैसा कि यहां दिखाया गया है इमेज.

नीचे दी गई टेबल में, उन डिफ़ॉल्ट वैल्यू के बारे में बताया गया है जो इनका इस्तेमाल करके पहले से भरी हुई हैं में दी गई प्रॉपर्टी शामिल हैं. OpenAPI की खास बातों का एक हिस्सा इस्तेमाल की गई प्रॉपर्टी की जानकारी, टेबल में दी गई है.

फ़ील्ड	ब्यौरा	डिफ़ॉल्ट
प्रॉक्सी नाम	एपीआई प्रॉक्सी का नाम. उदाहरण के लिए: `Mock-Target-API`.	OpenAPI स्पेसिफ़िकेशन से जुड़ी `title` प्रॉपर्टी को स्पेस के साथ बदला गया डैश के ज़रिए
प्रॉक्सी बेस पाथ	पाथ कॉम्पोनेंट, जो संगठन में इस एपीआई प्रॉक्सी की खास तौर पर पहचान करता है. इस एपीआई प्रॉक्सी के सार्वजनिक तौर पर दिखने वाले यूआरएल में आपके संगठन का नाम, वातावरण, जहां यह एपीआई प्रॉक्सी डिप्लॉय किया जाता है और यह बेस पाथ. इसके लिए उदाहरण: `http://myorg-test.apigee.net/mock-target-api`	नाम वाले फ़ील्ड के कॉन्टेंट को सभी लोअर केस में बदला गया
मौजूदा एपीआई	इस एपीआई प्रॉक्सी की ओर से टारगेट यूआरएल का अनुरोध किया गया. ऐसा कोई भी यूआरएल जिसे यहां से ऐक्सेस किया जा सकता है तो ओपन इंटरनेट का इस्तेमाल किया जा सकता है. जैसे: `http://mocktarget.apigee.net` अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है	OpenAPI की खास बातों से मिली `servers` प्रॉपर्टी
जानकारी	एपीआई प्रॉक्सी की जानकारी.	OpenAPI की खास बातों से मिली `description` प्रॉपर्टी

नीचे दिए गए ओपनएपीआई स्पेसिफ़िकेशन का एक हिस्सा है जो ऐसी प्रॉपर्टी जिनका इस्तेमाल फ़ील्ड में अपने-आप जानकारी भरने के लिए किया जाता है.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
...
servers:
  - url: http://mocktarget.apigee.net
  - url: https://mocktarget.apigee.net
...

ब्यौरा फ़ील्ड में इस तरह बदलाव करें: API proxy for the Apigee mock target service endpoint.
आगे बढ़ें पर क्लिक करें.
फ़्लो पेज पर, पक्का करें कि सभी कार्रवाइयां चुनी गई हैं.
अहम जानकारी: कंडिशनल फ़्लो अपने-आप जनरेट होते हैं OpenAPI में, paths ऑब्जेक्ट के अंदर तय की गई कार्रवाइयां खास जानकारी. कंडिशनल फ़्लो, Edge को बताती हैं कि "जब आपको यह दिखे, तो इस लॉजिक का इस्तेमाल करें." उदाहरण के लिए, जब एपीआई कॉल, /xml संसाधन (शर्त) पर एक जीईटी होता है, रिस्पॉन्स को JSON में बदलें (कंडिशनल फ़्लो से जुड़ी नीति की मदद से). सिर्फ़ हर लेन-देन के लिए एक फ़्लो एक्ज़ीक्यूट होता है—पहला फ़्लो जिसकी शर्त का आकलन होता है सही है.
आगे बढ़ें पर क्लिक करें.
सुरक्षा पेज पर, सुरक्षा के तौर पर पास थ्रू (कोई नहीं) को चुनें विकल्प चुनकर आगे बढ़ें पर क्लिक करें.
वर्चुअल होस्ट पृष्ठ पर, सुनिश्चित करें कि सभी वर्चुअल होस्ट चुने गए हैं और फिर आगे बढ़ें पर टैप करें.
बिल्ड पेज पर, पक्का करें कि टेस्ट एनवायरमेंट को चुना गया हो और बनाएं और डिप्लॉय करें पर क्लिक करें.
खास जानकारी वाले पेज पर, आपको यह सूचना दिखेगी कि आपका नया एपीआई प्रॉक्सी बना दिया गया है और टेस्ट एनवायरमेंट में डिप्लॉय किए जा सकते हैं.
एपीआई का खास जानकारी देने वाला पेज देखने के लिए, Mock-Target-API पर क्लिक करें प्रॉक्सी.

बधाई हो! आपने OpenAPI स्पेसिफ़िकेशन से, एपीआई प्रॉक्सी बनाया है. इसके बाद, आपको इसकी जांच करें और देखें कि यह कैसे काम करता है.

एपीआई प्रॉक्सी की जांच करना

यूआरएल या वेब ब्राउज़र का इस्तेमाल करके, Mock-Target-API एपीआई की जांच की जा सकती है.

टर्मिनल विंडो में, यहां दिया गया cURL निर्देश चलाएं. इसमें अपने संगठन का नाम बदलें यूआरएल पर क्लिक करें.

curl http://<org_name>-test.apigee.net/mock-target-api

जवाब

आपको यह जवाब दिखेगा:

Hello, Guest!

बहुत बढ़िया! आपने OpenAPI स्पेसिफ़िकेशन से, सामान्य एपीआई प्रॉक्सी बनाया है और टेस्ट कर लिया है इसे.

JSON नीति में एक्सएमएल जोड़ें

इसके बाद, आपको एक्सएमएल रिस्पॉन्स देखें में, एक्सएमएल को JSON नीति में जोड़ना होगा कंडिशनल फ़्लो, जो आपके एपीआई प्रॉक्सी को बनाने पर अपने-आप जनरेट होता है OpenAPI की खास बातें. यह नीति टारगेट के एक्सएमएल रिस्पॉन्स को JSON में बदल देगी जवाब.

सबसे पहले, एपीआई को कॉल करें, ताकि जोड़ने के बाद मिले नतीजों के साथ तुलना कर सकें नीति के बारे में ज़्यादा जानें. टर्मिनल विंडो में, नीचे दिया गया cURL निर्देश चलाएं. आप टारगेट सेवा का /xml संसाधन, जो मूल रूप से एक्सएमएल का सामान्य ब्लॉक दिखाता है. यूआरएल में अपने संगठन का नाम बदलें.

curl http://<org_name>-test.apigee.net/mock-target-api/xml

जवाब

आपको यह जवाब दिखेगा:

<root> 
  <city>San Jose</city> 
  <firstName>John</firstName> 
  <lastName>Doe</lastName> 
  <state>CA</state> 
</root>

आइए, अब कुछ करते हैं, जो एक्सएमएल रिस्पॉन्स को JSON में बदलता है. JSON नीति में एक्सएमएल जोड़ें एपीआई प्रॉक्सी में एक्सएमएल रिस्पॉन्स कंडिशनल फ़्लो तक.

मॉक-टारगेट एपीआई के सबसे ऊपर दाएं कोने में मौजूद, डेवलप करें टैब पर क्लिक करें Edge यूज़र इंटरफ़ेस (यूआई) में खास जानकारी देने वाला पेज.
बाएं नेविगेटर पैनल में, प्रॉक्सी एंडपॉइंट में > डिफ़ॉल्ट, View एक्सएमएल रिस्पॉन्स कंडिशनल फ़्लो.
नीचे दिए गए +चरण बटन पर क्लिक करें. फ़्लो के लिए जवाब.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
इसके बाद, 'चरण जोड़ें' डायलॉग बॉक्स खुलेगा. इसमें उन सभी नीतियों की कैटगरी की सूची दिखेगी जिन्हें आपके पास अनुमति है जोड़ें.
स्क्रोल करके मीडिएशन कैटगरी पर जाएं और एक्सएमएल से JSON चुनें.
डिसप्ले नेम के लिए डिफ़ॉल्ट वैल्यू बनाए रखें और नाम.
जोड़ें पर क्लिक करें. एक्सएमएल से JSON नीति, रिस्पॉन्स पर लागू होती है.
सेव करें पर क्लिक करें.

आपने नीति जोड़ दी है. इसलिए, अब cURL का इस्तेमाल करके एपीआई को फिर से कॉल करें. ध्यान दें कि आप अब भी उसी /xml संसाधन को कॉल किया जा रहा है. लक्षित सेवा अब भी अपना ब्लॉक XML है, लेकिन अब API प्रॉक्सी में मौजूद नीति रिस्पॉन्स को JSON में बदल देगी. इसे बनाएं कॉल:

curl http://<org_name>-test.apigee.net/mock-target-api/xml

ध्यान दें कि एक्सएमएल रिस्पॉन्स को JSON में बदला जाता है:

{"root":{"city":"San Jose","firstName":"John","lastName":"Doe","state":"CA"}}

बधाई हो! आपने कंडिशनल फ़्लो.