একটি OpenAPI স্পেসিফিকেশন থেকে একটি API প্রক্সি তৈরি করুন

আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশনে যান
তথ্য

আপনি কি শিখবেন

এই টিউটোরিয়ালে, আপনি শিখবেন:

  • একটি OpenAPI স্পেসিফিকেশন থেকে একটি এজ এপিআই প্রক্সি তৈরি করুন।
  • CURL ব্যবহার করে API প্রক্সিতে কল করুন।
  • শর্তসাপেক্ষ প্রবাহে একটি নীতি যোগ করুন।
  • সিআরএল ব্যবহার করে নীতি আহ্বান পরীক্ষা করুন।

এই টিউটোরিয়ালে, আপনি Apigee এজ ম্যানেজমেন্ট UI ব্যবহার করে একটি OpenAPI স্পেসিফিকেশন থেকে একটি Edge API প্রক্সি তৈরি করতে শিখবেন। যখন আপনি একটি HTTP ক্লায়েন্টের সাথে API প্রক্সি কল করেন, যেমন cURL, তখন API প্রক্সি অ্যাপিজি মক টার্গেট পরিষেবাতে অনুরোধ পাঠায়।

ওপেন এপিআই ইনিশিয়েটিভ সম্পর্কে

API উদ্যোগ খুলুন
"ওপেন এপিআই ইনিশিয়েটিভ (ওএআই) সোয়াগার স্পেসিফিকেশনের উপর ভিত্তি করে একটি বিক্রেতা নিরপেক্ষ API বর্ণনা বিন্যাস তৈরি, বিকাশ এবং প্রচারের উপর দৃষ্টি নিবদ্ধ করে।" Open API উদ্যোগ সম্পর্কে আরও তথ্যের জন্য, https://openapis.org দেখুন।

একটি OpenAPI স্পেসিফিকেশন একটি RESTful API বর্ণনা করতে একটি আদর্শ বিন্যাস ব্যবহার করে। JSON বা YAML ফর্ম্যাটে লেখা, একটি OpenAPI স্পেসিফিকেশন মেশিন রিডেবল, কিন্তু মানুষের পক্ষে পড়া এবং বোঝার জন্যও সহজ। স্পেসিফিকেশন একটি API-এর উপাদানগুলিকে এর বেস পাথ, পাথ এবং ক্রিয়া, শিরোনাম, ক্যোয়ারী প্যারামিটার, অপারেশন, বিষয়বস্তুর প্রকার, প্রতিক্রিয়া বিবরণ এবং আরও অনেক কিছু হিসাবে বর্ণনা করে। উপরন্তু, একটি OpenAPI স্পেসিফিকেশন সাধারণত API ডকুমেন্টেশন তৈরি করতে ব্যবহৃত হয়।

Apigee মক টার্গেট সেবা সম্পর্কে

এই টিউটোরিয়ালে ব্যবহৃত Apigee মক টার্গেট পরিষেবা Apigee-এ হোস্ট করা হয়েছে এবং সহজ ডেটা প্রদান করে। এটির জন্য কোন API কী বা অ্যাক্সেস টোকেনের প্রয়োজন নেই। আসলে, আপনি এটি একটি ওয়েব ব্রাউজারে অ্যাক্সেস করতে পারেন। নিম্নলিখিত ক্লিক করে এটি চেষ্টা করে দেখুন:

http://mocktarget.apigee.net

টার্গেট সার্ভিস অভিবাদন ফেরত দেয় Hello, guest!

মক টার্গেট পরিষেবা সমর্থন করে এমন APIগুলির সম্পূর্ণ সেট সম্পর্কে তথ্যের জন্য, নিম্নলিখিতটিতে ক্লিক করুন:

http://mocktarget.apigee.net/help

আপনি কি প্রয়োজন হবে

  • একটি Apigee এজ অ্যাকাউন্ট। আপনার যদি একটি অ্যাকাউন্ট না থাকে, আপনি একটি Apigee Edge অ্যাকাউন্ট তৈরি করার নির্দেশাবলী অনুসরণ করে সাইন আপ করতে পারেন৷
  • একটি OpenAPI স্পেসিফিকেশন। এই টিউটোরিয়ালে, আপনি mocktarget.yaml OpenAPI স্পেসিফিকেশন ব্যবহার করবেন যা Apigee-এর মক টার্গেট পরিষেবা, http://mocktarget.apigee.net বর্ণনা করে। আরও তথ্যের জন্য, https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi দেখুন।
  • কমান্ড লাইন থেকে API কল করতে আপনার মেশিনে cURL ইনস্টল করা হয়েছে; অথবা একটি ওয়েব ব্রাউজার।

API প্রক্সি তৈরি করুন

প্রান্ত

এজ UI ব্যবহার করে একটি OpenAPI স্পেসিফিকেশন থেকে API প্রক্সি তৈরি করতে:

  1. https://apigee.com/edge- এ সাইন ইন করুন।
  2. প্রধান উইন্ডোতে API প্রক্সিতে ক্লিক করুন।

    বিকল্পভাবে, আপনি বাম নেভিগেশন বারে বিকাশ > API প্রক্সি নির্বাচন করতে পারেন।

    ল্যান্ডিং পৃষ্ঠায় API প্রক্সিতে ক্লিক করুন

  3. + প্রক্সি ক্লিক করুন।
    API প্রক্সি যোগ করুন
  4. প্রক্সি তৈরি করুন উইজার্ডে, বিপরীত প্রক্সি (সবচেয়ে সাধারণ) টেমপ্লেটের জন্য OpenAPI স্পেক ব্যবহার করুন ক্লিক করুন।
    একটি প্রক্সি টাইপ তৈরি করুন
  5. URL থেকে আমদানি ক্লিক করুন এবং নিম্নলিখিত তথ্য লিখুন:
    • OpenAPI স্পেসিফিকেশন URL : URL ক্ষেত্রে OpenAPI স্পেসিফিকেশনের জন্য GitHub-এ কাঁচা বিষয়বস্তুর পাথ:
      https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
    • স্পেকের নাম : OpenAPI স্পেসিফিকেশনের জন্য নাম, যেমন মক টার্গেট

      এই নামটি স্পেক স্টোরে OpenAPI স্পেসিফিকেশন সংরক্ষণ করতে ব্যবহৃত হয়। দেখুন আপনার স্পেসিফিকেশন পরিচালনা করুন

  6. আমদানিতে ক্লিক করুন।

    প্রক্সি তৈরি করুন উইজার্ডের বিবরণ পৃষ্ঠা প্রদর্শন করে। ওপেনএপিআই স্পেসিফিকেশনে সংজ্ঞায়িত মান ব্যবহার করে ক্ষেত্রগুলি প্রাক-পপুলেট করা হয়েছে, যেমনটি নিম্নলিখিতটিতে দেখানো হয়েছে

    নিম্নলিখিত সারণীতে ডিফল্ট মানগুলি বর্ণনা করা হয়েছে যা OpenAPI স্পেসিফিকেশনের বৈশিষ্ট্যগুলি ব্যবহার করে প্রাক-পপুলেট করা হয়েছে। ওপেনএপিআই স্পেসিফিকেশনের একটি উদ্ধৃতি যা ব্যবহৃত বৈশিষ্ট্যগুলিকে চিত্রিত করে টেবিলের নিচে দেখানো হয়েছে।

    মাঠ বর্ণনা ডিফল্ট
    নাম API প্রক্সির নাম। যেমন: Mock-Target-API OpenAPI স্পেসিফিকেশন থেকে title বৈশিষ্ট্য ড্যাশ দ্বারা প্রতিস্থাপিত স্পেস সহ
    ভিত্তি পথ পাথ কম্পোনেন্ট যা প্রতিষ্ঠানের মধ্যে এই API প্রক্সিটিকে অনন্যভাবে সনাক্ত করে। এই API প্রক্সির সর্বজনীন-মুখী URL আপনার প্রতিষ্ঠানের নাম, একটি পরিবেশ যেখানে এই API প্রক্সি স্থাপন করা হয় এবং এই বেস পাথ নিয়ে গঠিত। যেমন: http://myorg-test.apigee.net/mock-target-api নাম ক্ষেত্রের বিষয়বস্তু সব ছোট হাতের মধ্যে রূপান্তরিত
    বর্ণনা API প্রক্সির বিবরণ। OpenAPI স্পেসিফিকেশন থেকে description সম্পত্তি
    লক্ষ্য (বিদ্যমান API) এই API প্রক্সির পক্ষে টার্গেট ইউআরএল আহ্বান করা হয়েছে। খোলা ইন্টারনেটের মাধ্যমে অ্যাক্সেসযোগ্য যে কোনও URL ব্যবহার করা যেতে পারে। যেমন: 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
    ...
    
  7. বর্ণনা ক্ষেত্রটি নিম্নরূপ সম্পাদনা করুন: API proxy for the Apigee mock target service endpoint.
  8. পরবর্তী ক্লিক করুন.
  9. সাধারণ নীতি পৃষ্ঠায়, সুরক্ষা: অনুমোদনের অধীনে নিশ্চিত করুন যে পাস থ্রু (কোন অনুমোদন নেই) নির্বাচন করা হয়েছে এবং পরবর্তী ক্লিক করুন :

    সাধারণ নীতি পৃষ্ঠায় নির্বাচিত মাধ্যমে পাস (কোন অনুমোদন নেই)

  10. প্রবাহ পৃষ্ঠায়, নিশ্চিত করুন যে সমস্ত ক্রিয়াকলাপ নির্বাচন করা হয়েছে৷একটি প্রক্সি ফ্লো তৈরি করুন
  11. পরবর্তী ক্লিক করুন.
  12. ভার্চুয়াল হোস্ট পৃষ্ঠায়, ডিফল্ট এবং সুরক্ষিত নির্বাচন করুন এবং পরবর্তীতে ক্লিক করুন।
    ভার্চুয়াল হোস্ট পৃষ্ঠায় ডিফল্ট এবং সুরক্ষিত নির্বাচিত
  13. সারাংশ পৃষ্ঠায়, পরীক্ষা পরিবেশটি ঐচ্ছিক স্থাপনার অধীনে নির্বাচন করা হয়েছে তা নিশ্চিত করুন এবং তৈরি করুন এবং স্থাপন করুন ক্লিক করুন :

    Apigee আপনার নতুন API প্রক্সি তৈরি করে এবং এটি আপনার পরীক্ষার পরিবেশে স্থাপন করে:

  14. API প্রক্সির জন্য ওভারভিউ পৃষ্ঠা প্রদর্শন করতে প্রক্সি সম্পাদনা করুন ক্লিক করুন।
    মক টার্গেট এপিআই প্রক্সির সারাংশ

ক্লাসিক এজ (ব্যক্তিগত ক্লাউড)

ক্লাসিক এজ UI ব্যবহার করে একটি OpenAPI স্পেসিফিকেশন থেকে API প্রক্সি তৈরি করতে:

  1. https://apigee.com/edge- এ সাইন ইন করুন।
  2. প্রধান উইন্ডোতে API প্রক্সিতে ক্লিক করুন।

    বিকল্পভাবে, আপনি বাম নেভিগেশন বারে বিকাশ > API প্রক্সি নির্বাচন করতে পারেন।

  3. + প্রক্সি ক্লিক করুন।
    API প্রক্সি যোগ করুন
  4. প্রক্সি তৈরি করুন উইজার্ডে, বিপরীত প্রক্সি (সবচেয়ে সাধারণ) নির্বাচন করুন এবং OpenAPI ব্যবহার করুন ক্লিক করুন।
    একটি প্রক্সি টাইপ তৈরি করুন
  5. URL থেকে আমদানিতে ক্লিক করুন, OpenAPI স্পেসিফিকেশনের জন্য একটি নাম লিখুন, এবং URL ক্ষেত্রে OpenAPI স্পেসিফিকেশনের জন্য GitHub-এ কাঁচা বিষয়বস্তুর পাথ লিখুন:

    https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml
  6. নির্বাচন ক্লিক করুন.
  7. পরবর্তী ক্লিক করুন.

    প্রক্সি তৈরি করুন উইজার্ডের বিবরণ পৃষ্ঠা প্রদর্শন করে। ওপেনএপিআই স্পেসিফিকেশনে সংজ্ঞায়িত মান ব্যবহার করে ক্ষেত্রগুলি পূর্ব-পপুলেট করা হয়েছে, যেমনটি নিম্নলিখিত চিত্রে দেখানো হয়েছে।

    একটি প্রক্সি বিবরণ তৈরি করুন

    নিম্নলিখিত সারণীতে ডিফল্ট মানগুলি বর্ণনা করা হয়েছে যা OpenAPI স্পেসিফিকেশনের বৈশিষ্ট্যগুলি ব্যবহার করে প্রাক-পপুলেট করা হয়েছে। ওপেনএপিআই স্পেসিফিকেশনের একটি উদ্ধৃতি যা ব্যবহৃত বৈশিষ্ট্যগুলিকে চিত্রিত করে টেবিলের নিচে দেখানো হয়েছে।

    মাঠ বর্ণনা ডিফল্ট
    প্রক্সি নাম API প্রক্সির নাম। যেমন: Mock-Target-API OpenAPI স্পেসিফিকেশন থেকে title বৈশিষ্ট্য ড্যাশ দ্বারা প্রতিস্থাপিত স্পেস সহ
    প্রক্সি বেস পাথ পাথ কম্পোনেন্ট যা প্রতিষ্ঠানের মধ্যে এই API প্রক্সিটিকে অনন্যভাবে সনাক্ত করে। এই API প্রক্সির সর্বজনীন-মুখী URL আপনার প্রতিষ্ঠানের নাম, একটি পরিবেশ যেখানে এই API প্রক্সি স্থাপন করা হয় এবং এই বেস পাথ নিয়ে গঠিত। যেমন: http://myorg-test.apigee.net/mock-target-api নাম ক্ষেত্রের বিষয়বস্তু সব ছোট হাতের মধ্যে রূপান্তরিত
    বিদ্যমান API এই API প্রক্সির পক্ষে টার্গেট ইউআরএল আহ্বান করা হয়েছে। খোলা ইন্টারনেটের মাধ্যমে অ্যাক্সেসযোগ্য যে কোনও URL ব্যবহার করা যেতে পারে। যেমন: http://mocktarget.apigee.net OpenAPI স্পেসিফিকেশন থেকে servers সম্পত্তি
    বর্ণনা API প্রক্সির বিবরণ। 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
    ...
    
  8. বর্ণনা ক্ষেত্রটি নিম্নরূপ সম্পাদনা করুন: API proxy for the Apigee mock target service endpoint.
  9. পরবর্তী ক্লিক করুন.
  10. প্রবাহ পৃষ্ঠায়, নিশ্চিত করুন যে সমস্ত ক্রিয়াকলাপ নির্বাচন করা হয়েছে৷একটি প্রক্সি ফ্লো তৈরি করুন
  11. পরবর্তী ক্লিক করুন.
  12. নিরাপত্তা পৃষ্ঠায়, নিরাপত্তা বিকল্প হিসাবে পাস থ্রু (কোনটি নয়) নির্বাচন করুন এবং পরবর্তী ক্লিক করুন।
  13. ভার্চুয়াল হোস্ট পৃষ্ঠায়, নিশ্চিত করুন যে সমস্ত ভার্চুয়াল হোস্ট নির্বাচন করা হয়েছে এবং পরবর্তী ক্লিক করুন।
  14. বিল্ড পৃষ্ঠায়, পরীক্ষা পরিবেশ নির্বাচন করা হয়েছে তা নিশ্চিত করুন এবং বিল্ড এবং ডিপ্লোয় ক্লিক করুন।
  15. সারাংশ পৃষ্ঠায়, আপনি একটি স্বীকৃতি দেখতে পাচ্ছেন যে আপনার নতুন API প্রক্সি সফলভাবে তৈরি করা হয়েছে এবং আপনার পরীক্ষার পরিবেশে স্থাপন করা হয়েছে।
    একটি প্রক্সি সারাংশ তৈরি করুন
  16. API প্রক্সির জন্য ওভারভিউ পৃষ্ঠা প্রদর্শন করতে Mock-Target-API-এ ক্লিক করুন।
    মক টার্গেট এপিআই প্রক্সির সারাংশ

অভিনন্দন! আপনি একটি OpenAPI স্পেসিফিকেশন থেকে একটি API প্রক্সি তৈরি করেছেন। এর পরে আপনি এটি কীভাবে কাজ করে তা দেখতে এটি পরীক্ষা করবেন।

API প্রক্সি পরীক্ষা করুন

আপনি CURL বা একটি ওয়েব ব্রাউজার ব্যবহার করে আপনার Mock-Target-API API পরীক্ষা করতে পারেন।

একটি টার্মিনাল উইন্ডোতে, নিম্নলিখিত cURL কমান্ডটি চালান। URL-এ আপনার প্রতিষ্ঠানের নাম প্রতিস্থাপন করুন।

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

প্রতিক্রিয়া

আপনি নিম্নলিখিত প্রতিক্রিয়া দেখতে হবে:

Hello, Guest!        

যাবার পথ! আপনি একটি OpenAPI স্পেসিফিকেশন থেকে একটি সাধারণ API প্রক্সি তৈরি করেছেন এবং এটি পরীক্ষা করেছেন৷

JSON নীতিতে একটি XML যোগ করুন

এরপর, আপনি XML-কে JSON নীতিতে যুক্ত করবেন দেখুন XML প্রতিক্রিয়া শর্তসাপেক্ষ প্রবাহে যা আপনি OpenAPI স্পেসিফিকেশন থেকে API প্রক্সি তৈরি করার সময় স্বয়ংক্রিয়ভাবে তৈরি হয়েছিল। নীতিটি লক্ষ্যের XML প্রতিক্রিয়াকে JSON প্রতিক্রিয়াতে রূপান্তর করবে৷

প্রথমে, API কল করুন যাতে আপনি নীতি যোগ করার পরে প্রাপ্ত ফলাফলের সাথে তুলনা করতে পারেন। একটি টার্মিনাল উইন্ডোতে নিম্নলিখিত cURL কমান্ডটি চালান। আপনি টার্গেট সার্ভিসের /xml রিসোর্সকে কল করছেন, যা স্থানীয়ভাবে XML এর একটি সাধারণ ব্লক প্রদান করে। URL-এ আপনার প্রতিষ্ঠানের নাম প্রতিস্থাপন করুন।

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>

এখন এমন কিছু করা যাক যা XML প্রতিক্রিয়াকে JSON-এ রূপান্তরিত করে। API প্রক্সিতে XML প্রতিক্রিয়া দেখুন শর্তসাপেক্ষ প্রবাহে JSON নীতিতে XML যোগ করুন।

  1. এজ UI-তে Mock-Target-API ওভারভিউ পৃষ্ঠার উপরের ডানদিকের বিকাশ ট্যাবে ক্লিক করুন।
    বিকাশকারী ট্যাব
  2. বাম ন্যাভিগেটর ফলকে, প্রক্সি এন্ডপয়েন্ট > ডিফল্টের অধীনে, XML প্রতিক্রিয়া দেখুন শর্তসাপেক্ষ প্রবাহে ক্লিক করুন।
    XML প্রতিক্রিয়া দেখুন নির্বাচন করুন
  3. নীচের + ধাপ বোতামে ক্লিক করুন, প্রবাহের প্রতিক্রিয়ার সাথে সম্পর্কিত।
    +পদক্ষেপ নির্বাচন করুন
    আপনি যোগ করতে পারেন এমন সমস্ত নীতির একটি শ্রেণীবদ্ধ তালিকা প্রদর্শন করতে পদক্ষেপ যোগ করুন ডায়ালগটি খোলে।
  4. মধ্যস্থতা বিভাগে স্ক্রোল করুন এবং XML থেকে JSON নির্বাচন করুন।
    ধাপ ডায়ালগ যোগ করুন
  5. ডিসপ্লে নাম এবং নামের জন্য ডিফল্ট মান রাখুন।
  6. যোগ করুন ক্লিক করুন. XML থেকে JSON নীতি প্রতিক্রিয়াতে প্রয়োগ করা হয়। XML থেকে JSON নীতি প্রবাহিত
  7. Save এ ক্লিক করুন।

এখন আপনি নীতি যোগ করেছেন, CURL ব্যবহার করে আবার API কল করুন। লক্ষ্য করুন যে আপনি এখনও একই /xml রিসোর্স কল করছেন। লক্ষ্য পরিষেবাটি এখনও তার XML ব্লক ফেরত দেয়, কিন্তু এখন API প্রক্সিতে থাকা নীতি JSON-এ প্রতিক্রিয়া রূপান্তর করবে৷ এই কল করুন:

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

মনে রাখবেন যে XML প্রতিক্রিয়া JSON এ রূপান্তরিত হয়েছে:

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

অভিনন্দন! আপনি একটি শর্তসাপেক্ষ প্রবাহে যোগ করা নীতির সম্পাদন সফলভাবে পরীক্ষা করেছেন।