আপনি Apigee Edge-এর ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন .info- তে যান।
ডিজাইন পর্যায়ে, আপনি আপনার এপিআই-এর জন্য প্রয়োজনীয়তাগুলো নির্ধারণ করেন। একজন এপিআই ডিজাইনার হিসেবে, আপনি গ্রাহকদের কাছে যে পরিষেবাগুলো উন্মুক্ত করতে চান তার পরিকল্পনা করেন এবং সেই পরিষেবাগুলো অ্যাক্সেস করার জন্য এপিআই ডিজাইন করেন। আপনার এপিআই-এর প্রয়োজনীয়তাগুলো লিপিবদ্ধ করার জন্য আপনি নিম্নলিখিত ডকুমেন্টগুলোর মধ্যে একটি তৈরি করেন:
- একটি ওপেনএপিআই নথি
- একটি GraphQL স্কিমা
নিম্নলিখিত বিভাগগুলিতে OpenAPI এবং GraphQL ডকুমেন্ট এবং আপনার API-এর জীবনচক্রে তাদের ভূমিকা সম্পর্কে আরও তথ্য দেওয়া হয়েছে। এই দুটি API ডিজাইন বিকল্পের তুলনার জন্য, এই ব্লগ পোস্টে REST এবং GraphQL-এর তুলনা দেখুন।
ওপেনএপিআই স্পেসিফিকেশন বলতে কী বোঝায়?
ওপেনএপিআই ইনিশিয়েটিভ (OAI)-এর মূল লক্ষ্য হলো সোয়াগার স্পেসিফিকেশনের উপর ভিত্তি করে একটি ভেন্ডর-নিরপেক্ষ এপিআই ডেসক্রিপশন ফরম্যাট তৈরি, উন্নত এবং প্রচার করা। ওপেনএপিআই ইনিশিয়েটিভ সম্পর্কে আরও তথ্যের জন্য, https://openapis.org দেখুন।
একটি ওপেনএপিআই ডকুমেন্ট একটি RESTful API বর্ণনা করার জন্য একটি স্ট্যান্ডার্ড ফরম্যাট ব্যবহার করে। JSON বা YAML ফরম্যাটে লেখা একটি ওপেনএপিআই ডকুমেন্ট মেশিন দ্বারা পাঠযোগ্য, আবার মানুষের জন্যও পড়া ও বোঝা সহজ। ওপেনএপিআই স্পেসিফিকেশন একটি এপিআই-এর বিভিন্ন উপাদানের, যেমন এর বেস পাথ, পাথ ও ভার্ব, হেডার, কোয়েরি প্যারামিটার, কন্টেন্ট টাইপ, রেসপন্স মডেল এবং আরও অনেক কিছুর আনুষ্ঠানিক বর্ণনা প্রদান করে। এছাড়াও, এপিআই ডকুমেন্টেশন তৈরি করার জন্য একটি ওপেনএপিআই ডকুমেন্ট সাধারণত ব্যবহৃত হয়।
এখানে একটি OpenAPI ডকুমেন্টের অংশবিশেষ দেওয়া হলো, যেখানে Apigee-এর সাধারণ 'হ্যালো ওয়ার্ল্ড' নমুনাটির বর্ণনা রয়েছে। আরও তথ্যের জন্য, GitHub- এ OpenAPI স্পেসিফিকেশনটি দেখুন।
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
/help:
get:
summary: Get help
operationId: Get help
description: View help information about available resources in HTML format.
responses:
"200":
description: Success
...
ওপেনএপিআই স্পেসিফিকেশন সম্পর্কে তথ্যের অনেক চমৎকার উৎস রয়েছে। শুরু করার জন্য একটি ভালো জায়গা হলো ওপেনএপিআই ইনিশিয়েটিভ সাইট, যেখানে আপনি ওভারভিউ, ব্লগ এবং ওপেনএপিআই স্পেসিফিকেশনের লিঙ্ক পাবেন। স্কিমা এলিমেন্ট এবং ডেটা টাইপগুলোর বিস্তারিত বিবরণের জন্য স্পেসিফিকেশনটি দেখুন।
ওপেনএপিআই স্পেসিফিকেশন রিপোজিটরি থেকে আপনি বেশ কিছু JSON এবং YAML উদাহরণ ওপেনএপিআই ডকুমেন্ট ডাউনলোড করতে পারেন।
GraphQL স্কিমা বলতে কী বোঝায়?
একটি GraphQL স্কিমা আপনার API-তে ক্লায়েন্টের কোয়েরি করার জন্য উপলব্ধ ডেটার বর্ণনা দেয়।
GraphQL ব্যবহারের সুবিধাগুলোর মধ্যে রয়েছে:
- একটি একক এন্ডপয়েন্ট একটি নির্দিষ্ট অপারেশনের সমস্ত ফিল্ডে অ্যাক্সেস প্রদান করে।
- স্কিমা ডেফিনিশন ল্যাঙ্গুয়েজ নামক শক্তিশালী কোয়েরি ভাষাটি আপনাকে ঠিক আপনার প্রয়োজনীয় ডেটা অ্যাক্সেস করতে সক্ষম করে, যা ডেটার অতিরিক্ত বা অপর্যাপ্ত ফেচিং প্রতিরোধ করে।
- কোয়েরিগুলোর প্রক্রিয়াকরণ সমান্তরালভাবে সম্পন্ন হয়।
GraphQL সম্পর্কে আরও তথ্যের জন্য graphql.org দেখুন।
নিম্নে একটি GraphQL স্কিমার উদাহরণ দেওয়া হলো, যা ডেটা এন্ট্রি পয়েন্ট (কোয়েরি টাইপ), উপলব্ধ রাইট অপারেশন (মিউটেশন টাইপ) এবং ডেটা টাইপসমূহকে সংজ্ঞায়িত করে।
type Query {
Greeting: String
students: [Student]
}
type Mutation {
createStudent(firstName: String!, lastName: String!): Student!
}
type Subscription {
newStudent: Student!
}
type Student {
Id: ID!
firstName: String!
lastName: String!
password: String!
collegeId: String!
}
আপনার প্রয়োজনীয় সঠিক ডেটা JSON পেলোড হিসেবে ফেরত পেতে আপনি GraphQL স্কিমা কোয়েরি করতে পারেন।
আমি যদি কোনো ডকুমেন্ট পরিবর্তন করি তাহলে কী হবে?
প্রতিটি OpenAPI বা GraphQL ডকুমেন্ট API লাইফসাইকেল জুড়ে তথ্যের নির্ভরযোগ্য উৎস হিসেবে কাজ করে। API লাইফসাইকেলের প্রতিটি পর্যায়ে, অর্থাৎ ডেভেলপমেন্ট থেকে শুরু করে পাবলিশিং ও মনিটরিং পর্যন্ত, একই ডকুমেন্ট ব্যবহৃত হয়।
যখন আপনি কোনো নথি সম্পাদনা বা মুছে ফেলেন, তখন তার প্রভাব পরবর্তীকালে পড়ে:
- আপনি যদি কোনো ডকুমেন্ট সম্পাদনা করেন, তাহলে আপনাকে এপিআই প্রক্সি এবং এর রিসোর্সগুলো প্রকাশকারী যেকোনো এপিআই প্রোডাক্ট সহ সংশ্লিষ্ট আর্টিফ্যাক্টগুলো ম্যানুয়ালি সম্পাদনা করতে হবে এবং ডকুমেন্টে বাস্তবায়িত পরিবর্তনগুলো প্রতিফলিত করার জন্য এপিআই রেফারেন্স ডকুমেন্টেশনটি পুনরায় তৈরি করতে হবে।
- যদি আপনি কোনো ডকুমেন্ট মুছে ফেলেন, তাহলে আপনাকে এপিআই প্রক্সি সহ সংশ্লিষ্ট আর্টিফ্যাক্টগুলো ম্যানুয়ালি মুছে ফেলতে হবে, যেকোনো এপিআই প্রোডাক্ট সম্পাদনা করে সংশ্লিষ্ট রিসোর্সগুলো মুছে ফেলতে হবে এবং ডকুমেন্ট ও এর রিসোর্সগুলোর অপসারণ প্রতিফলিত করার জন্য এপিআই রেফারেন্স ডকুমেন্টেশন পুনরায় তৈরি করতে হবে।
একটি OpenAPI ডকুমেন্ট থেকে API প্রক্সি তৈরি করলে কী হয়?
Edge-এ, আপনি আপনার OpenAPI ডকুমেন্ট থেকে API প্রক্সি তৈরি করতে পারেন। মাত্র কয়েকটি ক্লিকেই, পাথ, প্যারামিটার, কন্ডিশনাল ফ্লো এবং টার্গেট এন্ডপয়েন্ট স্বয়ংক্রিয়ভাবে তৈরি হয়ে যাবে। এরপর, আপনি OAuth সিকিউরিটি, রেট লিমিটিং এবং ক্যাশিং-এর মতো ফিচারগুলো যোগ করতে পারেন।
নিম্নলিখিত বিভাগগুলিতে বর্ণিত পদ্ধতি অনুসারে আপনি একটি OpenAPI ডকুমেন্ট থেকে একটি API প্রক্সি তৈরি করতে পারেন:
- স্পেক লিস্ট থেকে, যেমনটি "স্পেক লিস্টে থাকা একটি স্পেসিফিকেশন থেকে এপিআই প্রক্সি তৈরি করা" অংশে বর্ণনা করা হয়েছে। দ্রষ্টব্য : স্পেক লিস্টটি ক্লাসিক এজ-এ উপলব্ধ নয়।
- এপিআই প্রক্সি ম্যানেজার থেকে বিল্ড প্রক্সি উইজার্ড চালু করে এবং "প্রক্সি তৈরি করতে ওপেনএপিআই স্পেসিফিকেশন ব্যবহার করা" অংশে বর্ণিত পদ্ধতি অনুযায়ী একটি ওপেনএপিআই ডকুমেন্ট থেকে আপনার এপিআই প্রক্সি তৈরি করার বিকল্পটি বেছে নিন।
যখন আপনি আপনার এপিআই প্রকাশ করেন , তখন এপিআই রেফারেন্স ডকুমেন্টেশন তৈরি করার জন্য আপনি ওপেনএপিআই ডকুমেন্টের একটি স্ন্যাপশট নেন। সেই স্ন্যাপশটটি স্পেক স্টোরে থাকা ডেসক্রিপশন ডকুমেন্টের একটি নির্দিষ্ট রিভিশনের প্রতিনিধিত্ব করে।