আপনার API প্রকাশ করা (মূল ভার্সন)

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

নিচের বিভাগে বর্ণিত পদ্ধতি অনুযায়ী, অ্যাপ ডেভেলপারদের ব্যবহারের জন্য উপলভ্য করতে আপনার পোর্টালের API প্রকাশ করুন।

API প্রকাশ করা সংক্রান্ত ওভারভিউ

আপনার পোর্টাল API প্রকাশ করার প্রসেসটি দুটি ধাপে সম্পন্ন হয়:

  1. আপনার পোর্টালের জন্য যে API প্রোডাক্ট প্রকাশ করতে চান সেটি বেছে নিন।
  2. আপনার OpenAPI স্পেসিফিকেশনের স্ন্যাপশট থেকে API রেফারেন্স ডকুমেন্ট অটোমেটিক জেনারেট করুন যাতে অ্যাপ ডেভেলপাররা আপনার API সম্পর্কে জানতে পারেন। (স্ন্যাপশট সম্পর্কে আরও জানতে, OpenAPI স্পেসিফিকেশনের স্ন্যাপশট কী? দেখুন

আপনি পোর্টালে কোনও API প্রকাশ করলে, আপনার পোর্টালে নিম্নলিখিত আপডেটগুলি অটোমেটিক করা হয়:

  • আপনার পোর্টালে API রেফারেন্স পৃষ্ঠা যোগ করা হয়
    API রেফারেন্স পৃষ্ঠা, API রেফারেন্স ডকুমেন্টেশন দেখায় যা আপনার OpenAPI স্পেসিফিকেশনের স্ন্যাপশট থেকে আপনি অটোমেটিক তৈরি করেন। ডেভেলপাররা আপনার API ডকুমেন্টেশন পর্যালোচনা করতে এবং API অনুরোধ করতে ও আউটপুট দেখতে এটি ব্যবহার করে দেখুন বিকল্পে ক্লিক করতে পারবেন।

    মনে রাখবেন: আপনি এই পৃষ্ঠার কন্টেন্ট সরাসরি এডিট করতে পারবেন না; এটি আপনার পোর্টালের পৃষ্ঠার তালিকায় দেখা যায় না।

  • API পৃষ্ঠায় API রেফারেন্স পৃষ্ঠার লিঙ্ক যোগ করা হয়েছে
    API পৃষ্ঠায় (স্যাম্পেল পোর্টাল সহ) আপনার পোর্টালে প্রকাশিত সব API-এর একটি তালিকা দেওয়া থাকে এবং আরও তথ্যের জন্য সংশ্লিষ্ট API রেফারেন্স ডকুমেন্টেশনের লিঙ্কও দেওয়া থাকে।

    মনে রাখবেন: আপনি এই পৃষ্ঠার কন্টেন্ট সরাসরি এডিট করতে পারবেন না; এটি আপনার পোর্টালের পৃষ্ঠার তালিকায় দেখা যায় না।

OpenAPI স্পেসিফিকেশনের স্ন্যাপশট কী?

প্রতিটি OpenAPI স্পেসিফিকেশন API-এর সম্পূর্ণ লাইফসাইকেল জুড়ে সত্যের সোর্স হিসেবে কাজ করে। API লাইফসাইকেলের প্রতিটি ধাপে একই স্পেসিফিকেশন ব্যবহার করা হয়, ডেভেলপমেন্ট থেকে শুরু করে প্রকাশ করা ও মনিটর করা পর্যন্ত। আপনি কোনও স্পেসিফিকেশন পরিবর্তন করলে, স্পেসিফিকেশন পরিবর্তন করলে কী হয়? নিবন্ধে বর্ণিত অন্যান্য লাইফসাইকেল ফেজের মাধ্যমে আপনার API-তে হওয়া পরিবর্তনের প্রভাব সম্পর্কে আপনাকে সচেতন থাকতে হবে।

আপনি API প্রকাশ করার সময়, API রেফারেন্স ডকুমেন্ট তৈরি করতে OpenAPI স্পেসিফিকেশনের একটি স্ন্যাপশট নেন। ওই স্ন্যাপশট স্পেক স্টোরে স্পেসিফিকেশনের একটি নির্দিষ্ট ভার্সন দেখায়। আপনি স্পেক এডিটর ব্যবহার করে OpenAPI স্পেসিফিকেশন পরিবর্তন করলে, API রেফারেন্স ডকুমেন্টে লেটেস্ট পরিবর্তনগুলি প্রতিফলিত করার জন্য স্পেসিফিকেশনের আরেকটি স্ন্যাপশট নেওয়ার সিদ্ধান্ত নিতে পারেন।

আপনার API প্রক্সিতে CORS সহায়তা যোগ করা

আপনার API প্রকাশ করার আগে, ক্লায়েন্ট-সাইড ক্রস-অরিজিন অনুরোধের জন্য আপনার API প্রক্সিতে CORS সাপোর্ট যোগ করতে হবে।

CORS (ক্রস-অরিজিন রিসোর্স শেয়ারিং) হল একটি স্ট্যান্ডার্ড মেকানিজম যা জাভাস্ক্রিপ্ট XMLHttpRequest (XHR) কলকে কোনও ওয়েবপেজে এক্সিকিউট করে, যাতে সেটি নন-অরিজিন ডোমেনের রিসোর্সের সাথে ইন্টার‍্যাক্ট করতে পারে। CORS হল একই উৎস সম্পর্কিত নীতির একটি সাধারণ সমাধান যা সমস্ত ব্রাউজার প্রয়োগ করে। যেমন, আপনার ব্রাউজারে এক্সিকিউট করা জাভাস্ক্রিপ্ট কোড থেকে Twitter API-তে XHR কল করলে, কলটি ব্যর্থ হবে। এর কারণ হল, আপনার ব্রাউজারকে যে ডোমেন পৃষ্ঠা পরিবেশন করছে সেটি Twitter API পরিবেশনকারী ডোমেনের মতো নয়। ক্রস-অরিজিন রিসোর্স শেয়ারিং প্রদান করতে চাইলে, CORS সার্ভারকে "অপট-ইন" করার অনুমতি দিয়ে এই সমস্যার সমাধান করে।

API প্রকাশ করার আগে আপনার API প্রক্সিতে CORS সহায়তা যোগ করার ব্যাপারে তথ্য পেতে, API প্রক্সিতে CORS সহায়তা যোগ করা দেখুন।

মনে রাখবেন: বেশিরভাগ আধুনিক ব্রাউজার CORS প্রয়োগ করে। কাজ করে এমন ব্রাউজারের তালিকা ভালো করে দেখে নিন। CORS-এর বিস্তারিত বিবরণের জন্য, ক্রস-অরিজিন রিসোর্স শেয়ারিং W3C সাজেশন দেখুন।

API পৃষ্ঠা এক্সপ্লোর করা

API পৃষ্ঠা অ্যাক্সেস করতে:

  1. প্রকাশ করুন > পোর্টাল বিকল্প বেছে নিয়ে আপনার পোর্টাল বেছে নিন।
  2. পোর্টাল হোমপেজে API বিকল্পে ক্লিক করুন।

অথবা, আপনি উপরের নেভিগেশন বারে পোর্টাল ড্রপ-ডাউন মেনু থেকে API বেছে নিতে পারেন।

API-এর তালিকা দেখানো হয়।

API রেফারেন্স

আগের ছবিতে হাইলাইট করা অংশ থেকে বোঝা যায় যে API পৃষ্ঠা আপনাকে এগুলি করতে দেয়:

আপনার পোর্টালের সাথে API যোগ করা

মনে রাখবেন: আপনি নিজের পোর্টালের সাথে সর্বাধিক ১০০টি API যোগ করতে পারবেন।

আপনার পোর্টালে API যোগ করতে:

  1. প্রকাশ করুন > পোর্টাল বিকল্প বেছে নিয়ে আপনার পোর্টাল বেছে নিন।
  2. পোর্টাল হোমপেজে API বিকল্পে ক্লিক করুন।
    বিকল্প হিসেবে, আপনি উপরের নেভিগেশন বারে পোর্টাল ড্রপ-ডাউন মেনু থেকে API বেছে নিতে পারেন।
  3. + API বিকল্পে ক্লিক করুন।
    'পোর্টালে API প্রোডাক্ট যোগ করুন' ডায়ালগ দেখা যাবে।

  4. ডায়ালগে API প্রোডাক্ট ট্যাবে, আপনার পোর্টালের সাথে যে API প্রোডাক্ট যোগ করতে চান সেটি বেছে নিন।

  5. পরবর্তী বিকল্পে ক্লিক করুন।

  6. স্ন্যাপশটের জন্য ব্যবহার করার সোর্স বেছে নিন।
    আপনি যদি OpenAPI স্পেসিফিকেশন ব্যবহার করে API প্রোডাক্টে অন্তর্ভুক্ত API প্রক্সি তৈরি করে থাকেন, তাহলে ড্রপ-ডাউন তালিকা থেকে স্পেসিফিকেশন বেছে নিন।
    স্ন্যাপশট যোগ করা

    অথবা, আপনি এগুলি বেছে নিতে পারেন:

    • কোনও স্পেক নেই বিকল্প বেছে নিন এবং API প্রকাশ করার পরে স্পেসিফিকেশনের স্ন্যাপশট নেওয়া নিবন্ধে বর্ণিত পদ্ধতি অনুযায়ী স্পেক যোগ করুন।
    • নতুন স্পেসিফিকেশন বেছে নিতে বা আপলোড করতে, অন্য স্পেসিফিকেশন বেছে নিন বিকল্প বেছে নিন।

  7. আপনার পোর্টাল API প্রকাশ করতে, প্রকাশিত চেকবক্স বেছে নিন। API প্রকাশ করার জন্য প্রস্তুত না হলে, প্রকাশিত বিকল্পটি থেকে টিকচিহ্ন সরিয়ে দিন।
    আপনার পোর্টালে API প্রকাশ করা বা প্রকাশনা বাতিল করা নিবন্ধে বর্ণিত পদ্ধতি অনুযায়ী আপনি পরে সেটিং পরিবর্তন করতে পারবেন।

  8. আপনার API-এর দর্শক ম্যানেজ করতে, 'দর্শক' বিকল্পের অধীনে, অ্যাক্সেস দেওয়ার মাধ্যমে নিম্নলিখিত বিকল্পগুলির মধ্যে একটি বেছে নিন:

    • পরিচয় গোপনকারী ব্যবহারকারী যাতে সব ব্যবহারকারী পৃষ্ঠাটি দেখতে পান।
    • শুধুমাত্র রেজিস্টার করা ব্যবহারকারীদের পৃষ্ঠাটি দেখার অনুমতি দিতে রেজিস্টার করা ব্যবহারকারী।

    আপনার পোর্টালের API-এর জন্য দর্শক ম্যানেজ করা নিবন্ধে যেভাবে বর্ণনা করা হয়েছে, সেই অনুযায়ী আপনি পরে সেটিং পরিবর্তন করতে পারবেন।

  9. সম্পূর্ণ করুন বিকল্প বেছে নিন।

স্পেসিফিকেশনের স্ন্যাপশট নিন

আপনার API প্রকাশ করার পরে, আপনার পোর্টাল থেকে প্রকাশিত API রেফারেন্স ডকুমেন্টেশন আপডেট করতে, আপনি যেকোনও সময় OpenAPI স্পেসিফিকেশনের একটি নতুন স্ন্যাপশট নিতে পারবেন।

OpenAPI স্পেসিফিকেশনের স্ন্যাপশট নিতে:

  1. প্রকাশ করুন > পোর্টাল বিকল্প বেছে নিয়ে আপনার পোর্টাল বেছে নিন।
  2. পোর্টাল হোমপেজে API বিকল্পে ক্লিক করুন।
    বিকল্প হিসেবে, আপনি উপরের নেভিগেশন বারে পোর্টাল ড্রপ-ডাউন মেনু থেকে API বেছে নিতে পারেন।
  3. যে API-এর স্ন্যাপশট নিতে চান, তার উপরে কার্সর নিয়ে যান, যাতে অ্যাকশন দেখানো যায়।

  4. স্ন্যাপশট আইকন-এ ক্লিক করুন।

    মনে রাখবেন: বেছে নেওয়া সোর্স স্পেসিফিকেশন অনুযায়ী আপনার স্ন্যাপশট বর্তমান হলে একটি মেসেজ দেখানো হয়।

  5. স্ন্যাপশট সোর্স ড্রপ-ডাউন থেকে আগে থেকে থাকা কোনও স্পেসিফিকেশন বেছে নিন অথবা API-এর জন্য ডকুমেন্টেশন তৈরি করতে ব্যবহার করার জন্য নতুন স্পেসিফিকেশন বেছে নিতে বা আপলোড করতে অন্য স্পেসিফিকেশন বেছে নিন বিকল্প বেছে নিন। বিকল্প হিসেবে, বর্তমান স্পেসিফিকেশন সরিয়ে দিতে, আপনি কোনও স্পেক নেই বিকল্প বেছে নিতে পারেন।

  6. স্ন্যাপশট আপডেট করুন বিকল্পে ক্লিক করুন (অথবা আপনি কোনও স্পেক বেছে না নিলে স্ন্যাপশট সরিয়ে দিন বিকল্পে ক্লিক করুন)।

API রেফারেন্স ডকুমেন্টেশন স্পেসিফিকেশন থেকে তৈরি করা হয় এবং API রেফারেন্স পৃষ্ঠায় যোগ করা হয়।

আপনার পোর্টাল থেকে কোনও API প্রকাশ করা বা প্রকাশ করার তালিকা থেকে সরিয়ে দেওয়া

আপনার পোর্টাল থেকে কোনও API প্রকাশ করতে বা প্রকাশ করার তালিকা থেকে সরিয়ে দিতে:

  1. প্রকাশ করুন > পোর্টাল বিকল্প বেছে নিয়ে আপনার পোর্টাল বেছে নিন।
  2. পোর্টালের হোমপেজে API বিকল্পে ক্লিক করুন।
    বিকল্প হিসেবে, আপনি উপরের নেভিগেশন বারে পোর্টাল ড্রপ-ডাউন মেনু থেকে API বেছে নিতে পারেন।
  3. আপনি যে API প্রকাশ বা বাতিল করতে চান সেটির উপরে কার্সর রাখুন।
  4. সেটিংস আইকন-এ ক্লিক করুন।
  5. আপনার পোর্টাল থেকে API প্রকাশ করতে, চালু করা হয়েছে চেকবক্স বেছে নিন। API আনপাবলিশ করতে চালু করা আছে বিকল্পটি থেকে টিকচিহ্ন সরিয়ে দিন।
  6. সেভ করুন বিকল্পে ক্লিক করুন।

আপনার পোর্টালের API-এর জন্য দর্শক ম্যানেজ করা

আপনার পোর্টাল থেকে API-এর জন্য দর্শক ম্যানেজ করতে, এদের অ্যাক্সেস দিন:

  • সব ব্যবহারকারী
  • শুধুমাত্র রেজিস্টার করা ব্যবহারকারীদের জন্য

আপনার পোর্টালে কোনও API-এর জন্য দর্শক ম্যানেজ করতে:

  1. প্রকাশ করুন > পোর্টাল বিকল্প বেছে নিয়ে আপনার পোর্টাল বেছে নিন।
  2. পোর্টাল হোমপেজে API বিকল্পে ক্লিক করুন।
    বিকল্প হিসেবে, আপনি উপরের নেভিগেশন বারে পোর্টাল ড্রপ-ডাউন মেনু থেকে API বেছে নিতে পারেন।
  3. যে API-এর জন্য আপনি অ্যাকশন দেখাতে দর্শক ম্যানেজ করতে চান সেটির উপরে কার্সরটি রাখুন।
  4. সেটিংস আইকন-এ ক্লিক করুন।
  5. 'দর্শক' বিকল্পের মধ্যে, নিম্নলিখিত বিকল্পগুলির মধ্যে একটি বেছে নিন:
    • পরিচয় গোপনকারী ব্যবহারকারী যাতে সব ব্যবহারকারী API প্রোডাক্ট দেখতে পান।
    • শুধুমাত্র রেজিস্টার করা ব্যবহারকারীদের API প্রোডাক্ট দেখতে দেওয়ার জন্য রেজিস্টার করা ব্যবহারকারী।
  6. সেভ করুন বিকল্পে ক্লিক করুন।

আপনার পোর্টাল থেকে API সরিয়ে দেওয়া

আপনার পোর্টাল থেকে কোনও API সরাতে:

  1. প্রকাশ করুন > পোর্টাল বিকল্প বেছে নিয়ে আপনার পোর্টাল বেছে নিন।
  2. পোর্টালের হোমপেজে API বিকল্পে ক্লিক করুন।
    বিকল্প হিসেবে, আপনি উপরের নেভিগেশন বারে পোর্টাল ড্রপ-ডাউন মেনু থেকে API বেছে নিতে পারেন।
  3. অ্যাকশন মেনু দেখতে, তালিকায় API-এর উপরে কার্সর নিয়ে যান।
  4. মুছুন-এ ক্লিক করুন।

আপনার প্রকাশিত API সংক্রান্ত সমস্যার সমাধান করা

'এটি ব্যবহার করে দেখুন' ফিচার ব্যবহার করার সময়, TypeError: Failed to fetch সমস্যা হলে, সম্ভাব্য কারণ ও সমাধানগুলি বিবেচনা করুন:

  • মিক্সড কন্টেন্ট সংক্রান্ত সমস্যার ক্ষেত্রে, পরিচিত swagger-ui সমস্যার কারণে সমস্যা হতে পারে। সম্ভাব্য একটি সমাধান হল, আপনার OpenAPI স্পেসিফিকেশনে schemes ডেফিনিশনে HTTP-এর আগে HTTPS উল্লেখ করা হয়েছে কিনা তা নিশ্চিত করা। যেমন: 

     schemes:
   - https
   - http

  • CORS (ক্রস-অরিজিন রিসোর্স শেয়ারিং) সংক্রান্ত বিধিনিষেধের সমস্যার ক্ষেত্রে, আপনার API প্রক্সিতে CORS কাজ করে কিনা তা নিশ্চিত করুন। CORS হল একটি স্ট্যান্ডার্ড মেকানিজম যা ক্লায়েন্ট-সাইড ক্রস-অরিজিন অনুরোধ চালু করে। API প্রক্সির জন্য CORS সহায়তা যোগ করা দেখুন। আপনার ব্রাউজারেও CORS চালু আছে কিনা তা নিশ্চিত করুন।