APIs নথিভুক্ত করতে SmartDocs ব্যবহার করে

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

SmartDocs আপনাকে Drupal 7 ডেভেলপার পোর্টালে এমনভাবে আপনার APIগুলি নথিভুক্ত করতে দেয় যা API ডকুমেন্টেশনকে সম্পূর্ণরূপে ইন্টারেক্টিভ করে তোলে। ইন্টারেক্টিভ ডকুমেন্টেশন মানে পোর্টাল ব্যবহারকারীরা করতে পারেন:

• আপনার API সম্পর্কে পড়ুন
• আপনার API এ একটি লাইভ অনুরোধ পাঠান
• API থেকে ফিরে আসা একটি লাইভ প্রতিক্রিয়া দেখুন

আপনার API গুলিতে একটি ইন্টারেক্টিভ ডকুমেন্টেশন তৈরি করে, আপনি পোর্টাল ব্যবহারকারীদের জন্য আপনার APIগুলি শিখতে, পরীক্ষা করা এবং মূল্যায়ন করা সহজ করে তোলেন৷

এজ ম্যানেজমেন্ট API হল একটি RESTful API যা আপনাকে যেকোনো HTTP ক্লায়েন্ট ব্যবহার করে API পরিষেবাগুলি অ্যাক্সেস করতে সক্ষম করে। Apigee এজ ম্যানেজমেন্ট API এর জন্য ইন্টারেক্টিভ ডকুমেন্টেশন তৈরি করতে SmartDocs ব্যবহার করে। এখানে সেই API ডকুমেন্টেশন দেখুন।

SmartDocs পোর্টাল উদাহরণ

SmartDocs ব্যবহার করতে, আপনার অবশ্যই একটি Apigee বিকাশকারী পরিষেবা পোর্টাল থাকতে হবে। আরও তথ্যের জন্য, একটি বিকাশকারী পোর্টাল তৈরি করা দেখুন।

আপনার ডেভেলপার পোর্টাল হোম পেজ থেকে, এপিআই ডকুমেন্টেশন পৃষ্ঠাটি দেখতে উপরের নেভিগেশন বারে API এ ক্লিক করুন।

পোর্টালে নথিভুক্ত দুটি API রয়েছে: হ্যালো ওয়ার্ল্ড এবং পেট স্টোরের উদাহরণ।

Hello World API তৈরি করা হয়েছে মক টার্গেট OpenAPI স্পেসিফিকেশন, mocktarget.yaml থেকে। আরও তথ্যের জন্য, https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi দেখুন।

পোষা প্রাণী দোকান উদাহরণ API ক্লাসিক পোষা দোকান ডেমো থেকে তৈরি করা হয়েছে.

হ্যালো ওয়ার্ল্ড API অন্বেষণ করুন:

1. Hello World API এ ক্লিক করুন। হ্যালো ওয়ার্ল্ড API সারাংশ পৃষ্ঠা প্রদর্শিত হয়:
   
2. এপিআই নিশ্চিতকরণ দেখুন ক্লিক করুন। এই সম্পদের জন্য SmartDocs প্রদর্শিত হয়:
   
3. এই অনুরোধ পাঠান ক্লিক করুন.
4. ফিরে আসা প্রতিক্রিয়া দেখুন:

   HTTP/1.1 200 OK
   Connection:
   keep-alive
   Content-Length:
   18
   Content-Type:
   text/html; charset=utf-8
   Date:
   Tue, 21 Jun 2016 21:49:32 GMT
   ETag:
   W/"12-Jb9QP1bUxNSmZkxQGt5KLQ"
   X-Powered-By:
   Apigee
   <H2>I <3 APIs</H2>

5. অনুরোধটি দেখার জন্য অনুরোধ ট্যাবে ক্লিক করুন, অথবা সংশ্লিষ্ট cURL কল দেখতে cURL ট্যাবে ক্লিক করুন৷

SmartDocs ব্যবহার করে কিভাবে আপনার API গুলি নথিভুক্ত করবেন

SmartDocs একটি মডেল ব্যবহার করে আপনার APIগুলিকে উপস্থাপন করে, যেখানে মডেলটিতে আপনার API সম্পর্কে সমস্ত তথ্য রয়েছে৷ পোর্টাল পোর্টালে ডকুমেন্টেশন পৃষ্ঠাগুলিকে ড্রুপাল নোড হিসাবে রেন্ডার করার জন্য মডেল থেকে আপনার API সম্পর্কে তথ্য বের করে, যেখানে প্রতিটি ড্রুপাল নোড পোর্টালের ডকুমেন্টেশনের একটি পৃষ্ঠার সাথে মিলে যায়।

SmartDocs ব্যবহার করার জন্য আপনি যে সাধারণ পদক্ষেপগুলি অনুসরণ করেন তা হল:

1. পোর্টালে Drupal SmartDocs মডিউল কনফিগার করুন ।
2. একটি SmartDocs মডেল তৈরি করুন ।
3. একটি WADL ফাইল, OpenAPI (পূর্বে Swagger) স্পেসিফিকেশন বা ম্যানুয়ালি থেকে মডেলে API যোগ করুন ।
4. মডেলটিকে ড্রুপাল নোডের সংগ্রহ হিসাবে রেন্ডার করুন । প্রতিটি ড্রুপাল নোডে একটি একক API সম্পর্কে তথ্য রয়েছে। উদাহরণস্বরূপ, যদি আপনার API-এর একটি সংস্থান একটি POST এবং একটি PUT অনুরোধ উভয়কেই সমর্থন করে, SmartDocs POST এবং PUT-এর জন্য একটি পৃথক ড্রুপাল নোড তৈরি করে৷
5. ড্রুপাল নোডগুলি প্রকাশ করুন । একবার প্রকাশিত হলে, আপনার পোর্টাল ব্যবহারকারীরা আপনার API দেখতে এবং ইন্টারঅ্যাক্ট করতে পারবে।
6. ড্রুপাল নোডগুলি সম্পাদনা করুন , আপনি সেগুলি প্রকাশ করার আগে বা পরে। আপনি Drupal এডিটর ব্যবহার করে বা আসল WADL ফাইল বা OpenAPI স্পেসিফিকেশন সম্পাদনা করে Drupal নোড সম্পাদনা করতে পারেন। যখন আপনি WADL ফাইল বা OpenAPI স্পেসিফিকেশন সম্পাদনা শেষ করেন, তখন এটিকে নতুন সংশোধন হিসাবে মডেলে আবার আমদানি করুন, তারপর আপনার পরিবর্তনগুলি রেন্ডার করুন এবং প্রকাশ করুন৷
7. TLS সক্ষম করুন । যেহেতু SmartDocs আপনার API-কে অনুরোধ করার অংশ হিসাবে আপনার ব্যাকএন্ডে প্রমাণীকরণ শংসাপত্র পাঠাতে পারে, তাই সেই শংসাপত্রগুলি সুরক্ষিত কিনা তা নিশ্চিত করতে আপনার পোর্টালে TLS সক্ষম করা উচিত। পোর্টাল উত্পাদন এবং পরীক্ষার পরিবেশে, Apigee https:// অনুরোধ করার জন্য প্রয়োজনীয় TLS শংসাপত্র সরবরাহ করে। যাইহোক, আপনি আপনার পোর্টালের সাথে লাইভে যাওয়ার আগে, আপনাকে অবশ্যই আপনার নিজের TLS শংসাপত্র প্রাপ্ত করতে হবে এবং TLS সক্ষম করতে হবে। আরও জানতে, পোর্টালে TLS ব্যবহার দেখুন।

SmartDoc মডেল এবং টেমপ্লেট সম্পর্কে

আপনি যখন আপনার পোর্টালে একটি মডেল তৈরি করেন, মডেলটি আসলে আপনার এজ প্রতিষ্ঠানে সংরক্ষণ করা হয়, ড্রুপালে নয়। একটি মডেল হল একটি অভ্যন্তরীণ নাম (যেমন "my-smartdocs-api") সহ JSON-এর একটি বড় ব্লক এবং এটি একটি API-এর গঠনকে সংজ্ঞায়িত করে৷ আপনার পোর্টাল, অন্যদিকে, মডেলটিকে HTML এ রেন্ডার করে এবং মডেলটির জন্য একটি সম্পাদনা ইন্টারফেস প্রদান করে। পোর্টালে এপিআই-এর যেকোনো আপডেট স্বয়ংক্রিয়ভাবে উৎস মডেলে ফিরে যায়।

ধরে নিন যে আপনার প্রতিষ্ঠানে একাধিক পোর্টাল রয়েছে (উদাহরণস্বরূপ, dev, স্টেজ এবং প্রোডাকশন)। প্যানথিয়নে, আপনি একটি পোর্টালকে এক পরিবেশ থেকে অন্য পরিবেশে নিয়ে যান। পোর্টালের প্রতিটি দৃষ্টান্ত দেখে মনে হচ্ছে এটির নিজস্ব মডেল রয়েছে, কিন্তু তাদের সবকটিই উৎস মডেলের উল্লেখ করছে। আপনি যদি dev এ API সম্পাদনা করেন, মডেলটি আপডেট হয় এবং পরিবর্তনগুলি উত্পাদনে উপস্থিত হয়। একইভাবে, আপনি যদি dev-এ একটি মডেল মুছে দেন, উত্সটি মুছে ফেলা হয় এবং এটি আর উৎপাদনে উপলব্ধ থাকে না।

টেমপ্লেটগুলি আপনার SmartDocs-এর চেহারা এবং অনুভূতি নিয়ন্ত্রণ করে এবং সেই টেমপ্লেটগুলি (হ্যান্ডেলবার এবং CSS ফাইল দ্বারা নিয়ন্ত্রিত) প্রতিটি পোর্টাল উদাহরণের সাথে সংরক্ষণ করা হয়। তাই প্রতিটি পোর্টাল তাত্ত্বিকভাবে প্রতিটি মডেলের জন্য একটি অনন্য টেমপ্লেট ব্যবহার করতে পারে। যাইহোক, রেন্ডারিং ফ্রেমওয়ার্কের সুবিধাগুলির মধ্যে একটি হল যে একটি ডিফল্ট টেমপ্লেট (হয় Apigee ডিফল্ট বা আপনার দেওয়া একটি টেমপ্লেট) প্রতিটি মডেলে স্বয়ংক্রিয়ভাবে প্রয়োগ করা হয়।

নিম্নলিখিত চিত্রটি মডেল এবং পোর্টালগুলির মধ্যে সম্পর্ক দেখায়। সবুজ তীরগুলি স্বয়ংক্রিয় সিঙ্ক্রোনাইজেশন দেখায়।

নিম্নলিখিত cURL কমান্ড আপনার প্রতিষ্ঠানের সমস্ত মডেল তালিকাভুক্ত করে:

curl -v https://api.enterprise.apigee.com/v1/o/{your_org}/apimodels/ -u edge_org_admin@example.com

SmartDocs মডিউল কনফিগার করা হচ্ছে

Apigee একটি কাস্টম Drupal মডিউল হিসাবে SmartDocs প্রয়োগ করেছে। SmartDocs মডিউল কনফিগার করতে নিম্নলিখিত পদ্ধতি ব্যবহার করুন।

SmartDocs মডিউল কনফিগার করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. ড্রুপাল প্রশাসন মেনুতে মডিউল নির্বাচন করুন। সমস্ত ইনস্টল করা ড্রুপাল মডিউলের তালিকা প্রদর্শিত হবে।
3. SmartDocs মডিউল সক্ষম করুন।
4. কনফিগারেশন সংরক্ষণ করুন।
5. Drupal অ্যাডমিন মেনুতে মডিউল নির্বাচন করুন।
6. SmartDocs -> অনুমতিগুলি নির্বাচন করুন এবং নিশ্চিত করুন যে "প্রশাসক" ভূমিকার জন্য "SmartDocs মডিউলের জন্য প্রশাসনিক কার্য সম্পাদন করুন" সক্ষম করা আছে৷
7. ড্রুপাল প্রশাসন মেনুতে কনফিগারেশন > ডেভ পোর্টাল নির্বাচন করুন।
8. সংযোগের সময়সীমা সেট করুন এবং অনুরোধের সময়সীমা 16 সেকেন্ডে সেট করুন।
9. কনফিগারেশন সংরক্ষণ করুন।
10. URL সেটিংস কনফিগার করুন:
    1. ড্রুপাল মেনু থেকে কনফিগারেশন > অনুসন্ধান এবং মেটাডেটা > URL উপনাম > সেটিংস নির্বাচন করুন।
    2. সর্বাধিক উপনামের দৈর্ঘ্য এবং সর্বাধিক উপাদান দৈর্ঘ্য 255 এ সেট করুন।
    3. বিরাম চিহ্ন প্রসারিত করুন।
    4. বাম কোঁকড়া বন্ধনী ({) এবং ডান কোঁকড়া বন্ধনী (}) সেটিংসের জন্য, কোন কাজ নয় (প্রতিস্থাপন করবেন না) নির্বাচন করুন।
    5. কনফিগারেশন সংরক্ষণ করুন ক্লিক করুন।
11. যদি আপনার বিকাশকারী পোর্টালটি ইন্টারনেটে অ্যাক্সেস ছাড়াই একটি অভ্যন্তরীণ নেটওয়ার্কে ব্যবহারকারীদের কাছে উন্মুক্ত করা হয় বা যদি আপনার API-এর একটি উপসেট একটি ব্যক্তিগত নেটওয়ার্কে থাকে, তাহলে SmartDocs API প্রক্সি URLটি নিম্নরূপ কনফিগার করুন:
    1. ড্রুপাল অ্যাডমিনিস্ট্রেশন মেনুতে কনফিগারেশন > SmartDocs নির্বাচন করুন।
    2. উন্নত সেটিংস প্রসারিত করুন।
    3. SmartDocs প্রক্সি URL ফিল্ডটি নিম্নরূপ আপডেট করুন: < host >/smartdocs/v1/sendrequest ।
       ইনলাইন সাহায্য আপনার পরিবেশের জন্য প্রয়োজনীয় মান প্রদান করা উচিত. যেমন:
       https://api-us-east-1-enterprise.apigee.com/smartdocs/v1/sendrequest
       
       এই ক্ষেত্রটি https://apiconsole-prod.apigee.net/smartdocs/v1/sendrequest এ ডিফল্ট
    4. কনফিগারেশন সংরক্ষণ করুন ক্লিক করুন।

একটি মডেল তৈরি

একটি মডেল আপনার API এর উপস্থাপনা সম্পর্কে সমস্ত তথ্য ধারণ করে। আপনি বিভিন্ন API সমর্থন করতে পোর্টালে একাধিক মডেল সংজ্ঞায়িত করতে পারেন, বা আপনার সমস্ত API গুলিকে একটি একক মডেলে গোষ্ঠীবদ্ধ করতে পারেন৷

প্রতিটি মডেল একটি অনন্য অভ্যন্তরীণ নাম নির্দিষ্ট করে যা জেনারেট করা ড্রুপাল নোডের বেস ইউআরএলকেও সংজ্ঞায়িত করে। প্রতিটি ড্রুপাল নোডের URL ফর্মটিতে রয়েছে:

http://<drupalBasePath>/<internalName>/apis/<httpMethod>/<resourcePath>

কোথায়:

• drupalBasePath : আপনার পোর্টালের ভিত্তি URL।
• অভ্যন্তরীণ নাম : মডেলের অভ্যন্তরীণ নাম।
• httpMethod : API-এর HTTP পদ্ধতি, যেমন: get, put, post, or delete.
• resourcePath : সম্পদ পথ।

উদাহরণস্বরূপ, যদি আপনি 'mymodel' হিসাবে অভ্যন্তরীণ নাম নির্দিষ্ট করেন, তাহলে '/books' নামের একটি রিসোর্সে GET অনুরোধের জন্য জেনারেট করা ড্রুপাল নোডের URL হল:

http://prod-myco.devportal.apigee.com/mymodel/apis/get/books

একটি মডেল তৈরি করতে

আপনি যখন একটি মডেল তৈরি করেন, তখন এটি API কাঠামোর উত্স হিসাবে আপনার এজ সংস্থায় সংরক্ষণ করা হয়। আরও তথ্যের জন্য, SmartDoc মডেল এবং টেমপ্লেট সম্পর্কে দেখুন।

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. Drupal অ্যাডমিনিস্ট্রেশন মেনুতে Content > SmartDocs নির্বাচন করুন।
3. পৃষ্ঠার শীর্ষে নতুন মডেল নির্বাচন করুন।
4. নিম্নলিখিত ক্ষেত্রগুলি লিখুন:
   • নাম : মডেলের নাম যা পুরো সাইট জুড়ে প্রদর্শিত হবে।
   • অভ্যন্তরীণ নাম : আপনি নাম টাইপ করার সাথে সাথে অভ্যন্তরীণ নামটি প্রদর্শিত হবে। মডেলের অভ্যন্তরীণ নাম যা সকল মডেলের মধ্যে অনন্য হতে হবে। অভ্যন্তরীণ নামটিতে শুধুমাত্র ছোট হাতের অক্ষর, সংখ্যা এবং হাইফেন থাকতে হবে যেখানে কোন স্পেস নেই। এই নাম সম্পাদনা করতে সম্পাদনা নির্বাচন করুন।
   • বর্ণনা : মডেলের একটি বিবরণ।
5. মডেল তৈরি করুন নির্বাচন করুন।

আপনি মডেল তৈরি করার পরে, আপনাকে মডেলের পৃষ্ঠায় পুনঃনির্দেশিত করা হবে। সেখান থেকে, আপনি অপারেশন ড্রপ-ডাউন bx ব্যবহার করতে পারেন:

• আপনার API বর্ণনা করে একটি WADL ফাইল আমদানি করুন বা একটি OpenAPI স্পেসিফিকেশনের URL উল্লেখ করুন যা আপনার API বর্ণনা করে।
• মডেলে রিভিশন যোগ করুন
• মডেলের দ্বারা ব্যবহৃত স্টাইল শীট সহ মডেল সেটিংস পরিবর্তন করুন৷
• একটি ফাইলে মডেল রপ্তানি করুন ।
• মডেল মুছুন ।

একটি মডেলে API যোগ করা হচ্ছে

আপনি এর দ্বারা একটি মডেলে API যোগ করতে পারেন:

• API সংজ্ঞা সম্বলিত একটি WADL ফাইল আমদানি করা হচ্ছে
• একটি OpenAPI স্পেসিফিকেশন আমদানি করা হচ্ছে (OpenAPI 2.0 বা 1.2)
• ম্যানুয়ালি সম্পদ এবং পদ্ধতি তৈরি

আপনি একটি মডেলে একটি SmartDocs JSON ফাইল আমদানি করতে পারেন৷ এই ফাইলটি সাধারণত একটি বিদ্যমান মডেল রপ্তানি করে, ফাইলটি সম্পাদনা করে এবং তারপর আপডেটগুলি আমদানি করে তৈরি করা হয়। আরও জানতে, নীচে " একটি মডেল রপ্তানি এবং আমদানি করা " দেখুন৷

একটি WADL আমদানি করুন

আপনি সফলভাবে একটি মডেল তৈরি করার পরে, একটি WADL ফাইল আমদানি করুন যা আপনার API বর্ণনা করে। প্রতিবার যখন আপনি একটি WADL ফাইল আমদানি করেন, আপনি স্বয়ংক্রিয়ভাবে মডেলটির একটি নতুন সংশোধন তৈরি করেন।

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. Drupal অ্যাডমিনিস্ট্রেশন মেনুতে Content > SmartDocs নির্বাচন করুন।
3. আপনি আপডেট করতে চান মডেল নির্বাচন করুন.
4. অপারেশনের অধীনে, আমদানি নির্বাচন করুন।
5. SmartDocs আমদানি পৃষ্ঠায় Format ড্রপডাউনে WADL নির্বাচন করুন।
6. আপলোড টাইপ ড্রপডাউনে ফাইল বা URL নির্বাচন করুন।
   1. আপনি যদি ফাইল নির্বাচন করেন, তাহলে WADL ফাইলে ব্রাউজ করুন।
   2. আপনি URL নির্বাচন করলে, WADL ফাইলের URL উল্লেখ করুন।
7. মডেলে আমদানি করতে আমদানিতে ক্লিক করুন। আপনি এখন মডেল রেন্ডার করতে পারেন.
8. আপনাকে মডেলের তথ্য পৃষ্ঠায় পুনঃনির্দেশিত করা হয়েছে যেখানে আপনি এখন মডেলটি রেন্ডার করতে পারেন৷

একটি OpenAPI স্পেসিফিকেশন আমদানি করুন

আপনি সফলভাবে একটি মডেল তৈরি করার পরে, আপনি একটি OpenAPI (পূর্বে Swagger) স্পেসিফিকেশন আমদানি করতে পারেন। এজ OpenAPI সংস্করণ 1.2 এবং 2.0 সমর্থন করে।

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

একটি OpenAPI স্পেসিফিকেশন আমদানি করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. Drupal অ্যাডমিনিস্ট্রেশন মেনুতে Content > SmartDocs নির্বাচন করুন।
3. আপনি আপডেট করতে চান মডেল নির্বাচন করুন.
4. অপারেশনের অধীনে, আমদানি নির্বাচন করুন।
5. SmartDocs আমদানি পৃষ্ঠায় Format ড্রপডাউনে Swagger JSON বা Swagger YAML নির্বাচন করুন।
6. আপলোড টাইপ ড্রপডাউনে ফাইল বা URL নির্বাচন করুন (আপনাকে অবশ্যই OpenAPI 1.2 এর জন্য URL নির্বাচন করতে হবে)।
   1. আপনি যদি ফাইল নির্বাচন করেন, তাহলে OpenAPI স্পেসিফিকেশন ব্রাউজ করুন।
   2. আপনি URL নির্বাচন করলে, OpenAPI স্পেসিফিকেশনের URL উল্লেখ করুন।
7. মডেলে আমদানি করতে আমদানিতে ক্লিক করুন।
8. আপনাকে মডেলের তথ্য পৃষ্ঠায় পুনঃনির্দেশিত করা হয়েছে যেখানে আপনি এখন মডেলটি রেন্ডার করতে পারেন৷

ম্যানুয়ালি সম্পদ এবং পদ্ধতি তৈরি করুন

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

ম্যানুয়ালি একটি API যোগ করতে:

1. মডেলের একটি নতুন সংশোধন তৈরি করুন।
   
   আপনি যখন পুনর্বিবেচনা তৈরি করেন, আপনি মডেলের সমস্ত API-এর একক বেস পাথ নির্দিষ্ট করেন, মানে মডেলের সমস্ত API একই বেস পাথ ভাগ করে। উদাহরণস্বরূপ, বেস পাথটি উল্লেখ করুন:
   
   https://myCompany.com/v1
   
   আপনি যখন মডেলে সংস্থান যোগ করেন, তখন তারা বেস পাথ প্রসারিত করে।
2. মডেলের জন্য এক বা একাধিক সংস্থান সংজ্ঞায়িত করুন। রিসোর্স পাথ মডেল রিভিশনের বেস পাথের সাথে একত্রিত করে রিসোর্সের সম্পূর্ণ ইউআরএল নির্দিষ্ট করে। উদাহরণস্বরূপ, যদি আপনার সংস্থান "/ লগইন" এর একটি পথ সংজ্ঞায়িত করে, তবে সংস্থানের সম্পূর্ণ URL হল:
   
   https://myCompany.com/v1/login
3. প্রতিটি সম্পদের জন্য এক বা একাধিক পদ্ধতি সংজ্ঞায়িত করুন। একটি পদ্ধতি HTTP ক্রিয়া নির্দিষ্ট করে যা একটি সম্পদে আহ্বান করা যেতে পারে। উদাহরণস্বরূপ, "/ লগইন" সংস্থানের জন্য, আপনি লগইনের জন্য POST সমর্থন করেন এবং লগআউটের জন্য মুছে ফেলুন৷ এই সংস্থানটি অন্যান্য HTTP ক্রিয়াকে সমর্থন করে না, যেমন PUT বা GET। অতএব, সম্পদের জন্য দুটি পদ্ধতি সংজ্ঞায়িত করুন, একটি পোস্টের জন্য এবং একটি মুছে ফেলার জন্য।
   
   পদ্ধতিটি তার মূল সংস্থান থেকে সংস্থান URL ব্যবহার করে। অতএব, একই URL সহ সমস্ত পদ্ধতি SmartDocs-এ একটি একক সংস্থানের অধীনে সংজ্ঞায়িত করা হয়েছে৷

একটি সাধারণ নিয়ম হিসাবে:

• আপনার API-এ প্রতিটি অনন্য বেস পাথের জন্য একটি ভিন্ন SmartDocs মডেল তৈরি করুন।
• আপনার API-এ প্রতিটি অনন্য সম্পদের জন্য একটি ভিন্ন SmartDocs সংস্থান সংজ্ঞায়িত করুন।
• একটি সম্পদ দ্বারা সমর্থিত প্রতিটি HTTP ক্রিয়ার জন্য একটি ভিন্ন SmartDocs পদ্ধতি সংজ্ঞায়িত করুন।

একটি মডেলের একটি নতুন সংশোধন তৈরি করা

আপনি শুধুমাত্র একটি মডেলের বিদ্যমান সংশোধনে একটি সংস্থান যোগ করতে পারেন৷ যদি মডেলটির ইতিমধ্যে একটি সংশোধন থাকে, আপনি আপনার সংস্থান যোগ করতে পারেন। যদি মডেলটি নতুন হয় এবং কোনো সংশোধন না থাকে, তাহলে একটি নতুন সংশোধন তৈরি করুন।

একটি মডেলের একটি নতুন সংশোধন তৈরি করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. Drupal অ্যাডমিনিস্ট্রেশন মেনুতে Content > SmartDocs নির্বাচন করুন।
3. আপনি যে মডেলটি আপডেট করতে চান তার জন্য অপারেশনের অধীনে রিভিশন যোগ করুন নির্বাচন করুন।
4. API রিভিশন যোগ করুন পৃষ্ঠায়, নিম্নলিখিত তথ্য লিখুন:
   • প্রদর্শনের নাম : পোর্টালে প্রদর্শিত রিভিশনের নাম।
   • সংস্করণ আইডি : সংশোধনের জন্য একটি সংক্ষিপ্ত শনাক্তকারী।
   • বর্ণনা : সংশোধনের একটি বিবরণ।
   • বেস ইউআরএল : মডেলের রিভিশনে থাকা সমস্ত API-এর বেস ইউআরএল। একটি মডেল প্রতিটি রিভিশনের জন্য বিভিন্ন বেস ইউআরএল ব্যবহার করতে পারে। উদাহরণস্বরূপ, আপনি বেস URL-এ একটি সংস্করণ নির্দেশক অন্তর্ভুক্ত করেন। প্রথম মডেল সংশোধনের জন্য, বেস URL হল:
     https://myCompany.com/v1
     পরবর্তী পুনর্বিবেচনার জন্য, ভিত্তি URL হতে পারে:
     https://myCompany.com/v2
5. রিভিশন যোগ করুন নির্বাচন করুন। আপনাকে মডেলের সংশোধন পৃষ্ঠায় পুনঃনির্দেশিত করা হয়েছে। আপনি এখন মডেলে সম্পদ সংজ্ঞায়িত করতে পারেন।

একটি সম্পদ সংজ্ঞায়িত করা

একটি সংস্থান একটি API এর সম্পূর্ণ URL নির্দিষ্ট করে। একটি রিসোর্স সংজ্ঞায়িত করার সময়, আপনি রিসোর্স পাথ নির্দিষ্ট করেন, যেটি রিসোর্সের সম্পূর্ণ ইউআরএল তৈরি করতে মডেল রিভিশনে বেস ইউআরএলের সাথে মিলিত হয়।

একটি সম্পদ সংজ্ঞায়িত করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. Drupal অ্যাডমিনিস্ট্রেশন মেনুতে Content > SmartDocs নির্বাচন করুন।
3. আপনি যে মডেলটি আপডেট করতে চান তার জন্য, অপারেশনের অধীনে, একটি মডেলের সমস্ত সংশোধন দেখতে API সংশোধন নির্বাচন করুন।
4. সম্পাদনা করতে একটি সংশোধন নির্বাচন করুন.
5. পুনর্বিবেচনা পৃষ্ঠায়, ড্রপডাউন মেনু থেকে সম্পদ যোগ করুন নির্বাচন করুন।
6. সম্পদ যোগ করুন পৃষ্ঠায়, নিম্নলিখিত তথ্য লিখুন:
   • প্রদর্শনের নাম : সম্পদের নাম।
   • পাথ : সম্পদ পথ, "/" দিয়ে শুরু। রিসোর্সের সম্পূর্ণ ইউআরএল তৈরি করতে পাথের মান মডেল রিভিশনের বেস ইউআরএলের সাথে মিলিত হয়।
   • বর্ণনা : সম্পদের বর্ণনা।
   • পরামিতি : ঐচ্ছিকভাবে রিসোর্সের প্রতিটি প্যারামিটার সংজ্ঞায়িত করে JSON অবজেক্ট লিখুন। এই পরামিতিগুলি নীচে বর্ণিত হয়েছে।
7. রিসোর্স যোগ করুন নির্বাচন করুন। আপনাকে মডেল পৃষ্ঠায় পুনঃনির্দেশিত করা হয়েছে। আপনি এখন রিসোর্সে পদ্ধতি সংজ্ঞায়িত করতে পারেন।

ঐচ্ছিকভাবে, আপনি রিসোর্সে প্যারামিটার যোগ করতে পারেন, যেমন টেমপ্লেট, ক্যোয়ারী এবং হেডার প্যারামিটার। সমস্ত রিসোর্স প্যারামিটার সেই রিসোর্সে সংজ্ঞায়িত যেকোনো পদ্ধতি দ্বারা উত্তরাধিকারসূত্রে প্রাপ্ত হয়। অতএব, আপনি যদি রিসোর্সে একটি ক্যোয়ারী প্যারামিটার সংজ্ঞায়িত করেন, সেই রিসোর্সে যোগ করা সমস্ত পদ্ধতি অবশ্যই সেই ক্যোয়ারী প্যারামিটারকে সমর্থন করবে।

বিকল্পভাবে, আপনি একটি পদ্ধতিতে পরামিতি সংজ্ঞায়িত করতে পারেন। উদাহরণস্বরূপ, একটি POST পদ্ধতি কোয়েরি প্যারামিটারগুলিকে সমর্থন করতে পারে যা একটি DELETE পদ্ধতি দ্বারা সমর্থিত নয়৷ অতএব, আপনি যখন পদ্ধতিটি সংজ্ঞায়িত করবেন তখন একটি পদ্ধতিতে নির্দিষ্ট যেকোন পরামিতি যোগ করুন, যেমনটি নীচে বর্ণনা করা হয়েছে।

নিম্নলিখিত চিত্রটি Apigee অনুমোদন বা প্রত্যাহার ডেভেলপার অ্যাপ API-এর জন্য একটি বিদ্যমান SmartDocs পৃষ্ঠা দেখায় যেখানে প্রতিটি ধরণের প্যারামিটার হাইলাইট করা হয়েছে:

প্রতিটি পরামিতি প্রকার একটি JSON অবজেক্ট দ্বারা সংজ্ঞায়িত করা হয়:

একটি টেমপ্লেট প্যারামিটার রিসোর্স পাথের একটি পরিবর্তনশীলকে সংজ্ঞায়িত করে। উদাহরণস্বরূপ, আপনি সম্পদে দুটি টেমপ্লেট পরামিতি সংজ্ঞায়িত করেন। লক্ষ্য করুন কিভাবে প্যারামিটার অ্যারের প্রতিটি প্যারামিটার সংজ্ঞা একটি কমা দ্বারা পৃথক করা হয়:

[
 {
  "dataType": "string",
  "defaultValue": "",
  "description": "Mention the organization name.",
  "name": "org_name",
  "required": true,
  "type": "TEMPLATE"
 },
 {
  "dataType": "string",
  "defaultValue": "",
  "description": "Mention the user email.",
  "name": "developer_email",
  "required": true,
  "type": "TEMPLATE"
 }
]

তারপরে আপনি "{}" এ আবদ্ধ রিসোর্স পাথ সংজ্ঞায় টেমপ্লেট প্যারামিটার ব্যবহার করতে পারেন। উদাহরণস্বরূপ, পাথ সেট করুন:

/login/{org_name}/{developer_email}

SmartDocs API পৃষ্ঠায়, ব্যবহারকারীকে অনুরোধ জমা দেওয়ার আগে URL-এর org_name এবং developer_email অংশ নির্দিষ্ট করতে URL সম্পাদনা করতে হবে।

একটি পদ্ধতি সংজ্ঞায়িত করা

প্রতিটি সম্পদের জন্য এক বা একাধিক পদ্ধতি সংজ্ঞায়িত করুন। পদ্ধতির সংজ্ঞাটি একটি HTTP ক্রিয়া নির্দিষ্ট করে যা সম্পদে আহ্বান করা যেতে পারে। একটি সম্পদের একটি একক পদ্ধতি বা একাধিক পদ্ধতি সংজ্ঞায়িত থাকতে পারে।

পদ্ধতিটি সংজ্ঞায়িত করার অংশ হিসাবে, পদ্ধতি দ্বারা ব্যবহৃত যেকোন প্যারামিটার উল্লেখ করুন, যার মধ্যে ক্যোয়ারী এবং হেডার প্যারামিটার রয়েছে। একটি পদ্ধতিতে পরামিতি যোগ করার বিষয়ে তথ্যের জন্য সম্পদের জন্য উপরের বর্ণনাটি দেখুন।

নিম্নলিখিত চিত্রটি Apigee Create Developer API-এর জন্য একটি বিদ্যমান SmartDocs পৃষ্ঠা দেখায় যার সাথে পৃষ্ঠার প্রতিটি এলাকা হাইলাইট করা সংশ্লিষ্ট মান দিয়ে আপনি একটি পদ্ধতি সংজ্ঞায়িত করার সময় সেট করেন:

পরবর্তী চিত্রটি একই পৃষ্ঠা দেখায় তবে অনুরোধের বডির বর্ণনার সাথে নির্বাচিত:

একটি পদ্ধতি সংজ্ঞায়িত করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. Drupal অ্যাডমিনিস্ট্রেশন মেনুতে Content > SmartDocs নির্বাচন করুন।
3. আপনি যে মডেলটি আপডেট করতে চান তার জন্য, অপারেশনের অধীনে, একটি মডেলের সমস্ত সংশোধন দেখতে API সংশোধন নির্বাচন করুন।
4. সম্পাদনা করতে একটি সংশোধন নির্বাচন করুন.
5. রিভিশন পৃষ্ঠায়, রিসোর্সের একটির জন্য ড্রপডাউন মেনু থেকে পদ্ধতি যোগ করুন নির্বাচন করুন।
6. সম্পাদনা পদ্ধতি পৃষ্ঠায়, নিম্নলিখিত তথ্য লিখুন:
   • প্রদর্শনের নাম : API-এর নাম, যা API-এর জন্য Drupal পৃষ্ঠার শিরোনামও হয়ে যায়।
   • বর্ণনা : API বর্ণনা করুন।
   • পদ্ধতি ক্রিয়া : HTTP ক্রিয়া প্রকার।
   • নিরাপত্তা স্কিম : পদ্ধতির জন্য প্রমাণীকরণ মোড, যদি থাকে, নির্দিষ্ট করুন। আরও জানতে, SmartDocs প্রমাণীকরণের ধরন কনফিগার করা দেখুন।
   • বিষয়বস্তুর প্রকার : অনুরোধ এবং প্রতিক্রিয়ার বিষয়বস্তুর প্রকার। বিভিন্ন প্রমাণীকরণ পদ্ধতি কনফিগার করার বিষয়ে নীচের বিভাগটি দেখুন।
   • পরামিতি : (ঐচ্ছিক) পদ্ধতির জন্য যেকোনো প্রশ্ন বা হেডার পরামিতি। আরও তথ্যের জন্য একটি সম্পদে একটি প্যারামিটার যোগ করার জন্য উপরের বর্ণনাটি দেখুন।
   • রিকোয়েস্ট বডি ডকুমেন্টেশন : (ঐচ্ছিক) রিকোয়েস্ট বডি বর্ণনা করুন। POST এবং PUT পদ্ধতিগুলি একটি অনুরোধের অংশ গ্রহণ করে। আপনি এটি বর্ণনা করতে এই এলাকা ব্যবহার করতে পারেন. আপনি যদি এই মানটি বাদ দেন, তাহলে জেনারেট করা SmartDocs পৃষ্ঠা থেকে Request Body-এর অধীনে বিবরণ লিঙ্কটি বাদ দেওয়া হবে।
   • রিকোয়েস্ট বডি উদাহরণ : (ঐচ্ছিক) রিকোয়েস্ট বডির একটি উদাহরণ দেখান, সাধারণত একটি JSON অবজেক্ট বা XML হিসেবে। POST এবং PUT ক্রিয়াগুলির জন্য, প্রতিটি অনুরোধের অংশ হিসাবে অনুরোধের মূল উদাহরণটি পাস করা হয়। SmartDocs পৃষ্ঠার ব্যবহারকারীরা API এ একটি অনুরোধ জমা দেওয়ার আগে এই উদাহরণটি সম্পাদনা করে৷ আপনি যদি এই মানটি বাদ দেন, তাহলে রিকোয়েস্ট বডির অধীনে থাকা মান লিঙ্কটি জেনারেট করা SmartDocs পৃষ্ঠা থেকে বাদ দেওয়া হবে।
   • ট্যাগ : API এর সাথে যুক্ত ট্যাগগুলির একটি অ্যারে। SmartDocs একই ধরনের API গুলিকে একসাথে গোষ্ঠীভুক্ত করতে ট্যাগ ব্যবহার করে। উদাহরণস্বরূপ, আপনি পরিসংখ্যান সম্পর্কে সমস্ত API-এ "পরিসংখ্যান" ট্যাগ প্রয়োগ করতে পারেন৷ আপনি একটি একক ট্যাগের অধীনে বিভিন্ন সংস্থান থেকে API গুলিকে গ্রুপ করতে পারেন৷ যদি তারা সবাই একই ট্যাগ ব্যবহার করে।
7. পদ্ধতি যোগ করুন নির্বাচন করুন। আপনাকে মডেল পৃষ্ঠায় পুনঃনির্দেশিত করা হয়েছে। আপনি এখন আপনার পদ্ধতি রেন্ডার এবং প্রকাশ করতে পারেন।

একটি মডেল রেন্ডারিং

আপনি একটি মডেলে API যোগ করার পরে, আপনি মডেলটি রেন্ডার করতে পারেন। রেন্ডারিং এপিআই-এর মডেলের বর্ণনাকে ড্রুপাল নোডে রূপান্তর করে। রেন্ডারিং সম্পূর্ণ হলে, প্রতিটি API-এর জন্য আপনার কাছে একটি একক ড্রুপাল নোড থাকবে, যেখানে প্রতিটি ড্রুপাল নোড একটি HTML পৃষ্ঠার সাথে মিলে যায়।

আপনি একবারে সম্পূর্ণ মডেল রেন্ডার করতে বা রেন্ডারিংয়ের জন্য পৃথক API নির্বাচন করতে পারেন৷

একটি মডেল রেন্ডার করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. Drupal অ্যাডমিনিস্ট্রেশন মেনুতে Content > SmartDocs নির্বাচন করুন।
3. আপনি যে মডেলটি রেন্ডার করতে চান তার জন্য, অপারেশনের অধীনে API রিভিশন নির্বাচন করুন।
4. আপনি রেন্ডার করতে চান তা নির্বাচন করুন. আপনি শুধুমাত্র মডেলের একটি একক সংশোধন থেকে নোড রেন্ডার করতে পারেন।
5. রেন্ডার করার পদ্ধতি নির্বাচন করুন।
6. আপডেট অপশন ড্রপডাউন থেকে রেন্ডার নোড নির্বাচন করুন।
7. আপডেট ক্লিক করুন.
8. একটি লোডিং স্ক্রীন আপনার নোড রেন্ডার করা হচ্ছে অগ্রগতি দেখতে প্রদর্শিত হবে.
   নোডগুলি রেন্ডার হওয়ার পরে, প্রতিটি API-এর জন্য ড্রুপাল নোডের ID মডেলের নোড অ্যাসোসিয়েশন কলামের অধীনে প্রদর্শিত হয়। রেন্ডার করা নোড দেখতে নোড অ্যাসোসিয়েশন কলামের লিঙ্কে ক্লিক করুন।

রেন্ডার নোড নির্বাচন করার পরিবর্তে, আপনি রেন্ডার নির্বাচন করতে পারেন এবং নোড প্রকাশ করতে পারেন এবং অবিলম্বে APIগুলিকে ড্রুপাল নোড হিসাবে প্রকাশ করতে পারেন।

প্রকাশনা নোড

একটি নোড প্রকাশিত না হওয়া পর্যন্ত পোর্টাল ব্যবহারকারীদের কাছে দৃশ্যমান নয়। রেন্ডারিং প্রক্রিয়া চলাকালীন আপনি ঐচ্ছিকভাবে নোড প্রকাশ করতে বেছে নিতে পারেন। আপনি যদি নোডগুলি প্রকাশ না করা বেছে নেন, তাহলে রেন্ডারিং সম্পূর্ণ হওয়ার পরে আপনাকে ম্যানুয়ালি সেগুলি প্রকাশ করতে হবে।

একটি নোড প্রকাশ করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. Drupal অ্যাডমিনিস্ট্রেশন মেনুতে Content > SmartDocs নির্বাচন করুন।
3. আপনি যে মডেলটি প্রকাশ করতে চান তার জন্য, অপারেশনের অধীনে API রিভিশন নির্বাচন করুন।
4. আপনি যে রিভিশনটি প্রকাশ করতে চান সেটি নির্বাচন করুন। আপনি শুধুমাত্র মডেলের একটি একক সংশোধন থেকে নোড প্রকাশ করতে পারেন।
5. প্রকাশ করার পদ্ধতি নির্বাচন করুন।
6. প্রকাশ করতে রিভিশনে নোড নির্বাচন করুন।
7. আপডেট অপশন ড্রপডাউন থেকে Publish Nodes নির্বাচন করুন।
8. আপডেট ক্লিক করুন.
9. নোড অ্যাসোসিয়েশন কলামের অধীনে নোড আইডি নির্বাচন করে নোডে নেভিগেট করুন।

ডিফল্টরূপে, একটি প্রকাশিত API নোডের ড্রুপাল ইউআরএল ফর্মে থাকে: http://< drupalBasePath >/< internalName >/apis/< httpMethod >/< resourcePath > । URL এর ফর্ম নিয়ন্ত্রণ করতে নিম্নলিখিত পদ্ধতি ব্যবহার করুন:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. ড্রুপাল অ্যাডমিনিস্ট্রেশন মেনুতে কনফিগারেশন > অনুসন্ধান এবং মেটাডেটা > URL উপনাম > প্যাটার্ন নির্বাচন করুন।
3. সমস্ত SmartDocs মেথড পাথের প্যাটার্নের অধীনে আপনি কীভাবে পাথ তৈরি করতে চান তা নির্দিষ্ট করে।
4. কনফিগারেশন সংরক্ষণ করুন নির্বাচন করুন।

পোর্টালে ক্যাশে করার কারণে, আপনি হয়ত আপনার মডেল পৃষ্ঠাগুলি প্রকাশ করার সাথে সাথে প্রদর্শিত হতে দেখতে পাবেন না। প্রয়োজনে, আপনি নিম্নলিখিত পদ্ধতি ব্যবহার করে ম্যানুয়ালি SmartDocs HTML ক্যাশে সাফ করতে পারেন:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. ড্রুপাল প্রশাসন মেনুতে কনফিগারেশন > SmartDocs নির্বাচন করুন।
3. Rebuild SmartDocs মডেল ক্যাশে ক্লিক করুন।

একটি নোড প্রকাশনা

আপনি যে কোনো সময়ে একটি প্রকাশিত নোডের প্রকাশ বাতিল করতে পারেন। একটি নোড প্রকাশনা পোর্টাল ব্যবহারকারীদের কাছে অদৃশ্য করে তোলে।

একটি নোড প্রকাশ না করার জন্য:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. Drupal অ্যাডমিনিস্ট্রেশন মেনুতে Content > SmartDocs নির্বাচন করুন।
3. আপনি যে মডেলটি প্রকাশ না করতে চান তার জন্য, অপারেশনের অধীনে API রিভিশন নির্বাচন করুন।
4. আপনি যে নোডটি প্রকাশ না করতে চান তার মডেল সংশোধন নির্বাচন করুন।
5. অপ্রকাশিত করতে রিভিশনে নোড নির্বাচন করুন।
6. Update অপশন ড্রপডাউন থেকে Unpublish Nodes নির্বাচন করুন।
7. আপডেট ক্লিক করুন.

একটি মডেলের রিভিশন দেখছেন

আপনি একটি বিদ্যমান মডেলে একটি নতুন WADL ফাইল বা OpenAPI স্পেসিফিকেশন আমদানি করে, অথবা ম্যানুয়ালি একটি নতুন সংশোধন তৈরি করে একটি মডেলের একটি নতুন সংশোধন তৈরি করুন৷ নতুন রিভিশন তৈরি করার পর, আপনি রিভিশনটি রেন্ডার এবং প্রকাশ করতে পারেন, যা বর্তমানে প্রকাশিত ড্রুপাল নোডগুলিকে প্রতিস্থাপন করে।

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

একটি মডেলের সংশোধন দেখতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. Drupal অ্যাডমিনিস্ট্রেশন মেনুতে Content > SmartDocs নির্বাচন করুন।
3. আপনি যে মডেলটি আপডেট করতে চান তার জন্য, অপারেশনের অধীনে API রিভিশন নির্বাচন করুন।
4. আপনি দেখতে চান মডেল সংশোধন নির্বাচন করুন.
5. উপরে বর্ণিত নোডগুলি রেন্ডার করুন এবং প্রকাশ করুন।

একটি নোড সম্পাদনা করা হচ্ছে

আপনি একটি নোড রেন্ডার করার পরে, আপনি Drupal সম্পাদক ব্যবহার করে এটি সম্পাদনা করতে পারেন। উদাহরণস্বরূপ, আপনি একটি API-এর HTTP ক্রিয়া এবং বিবরণ সম্পাদনা করতে পারেন, অথবা API-তে একটি নতুন ক্যোয়ারী বা হেডার প্যারামিটার যোগ করতে পারেন। আপনি একটি WADL ফাইল বা OpenAPI স্পেসিফিকেশন বা ম্যানুয়ালি তৈরি করা নোডগুলি থেকে তৈরি নোডগুলি সম্পাদনা করতে পারেন৷

আপনি মূল WADL ফাইল বা OpenAPI স্পেসিফিকেশনও সম্পাদনা করতে পারেন। আপনার সম্পাদনা শেষ হয়ে গেলে, WADL ফাইল বা OpenAPI স্পেসিফিকেশনটিকে নতুন রিভিশন হিসাবে মডেলে আবার আমদানি করুন, তারপর উপরে বর্ণিত আপনার পরিবর্তনগুলি রেন্ডার করুন এবং প্রকাশ করুন৷

ড্রুপাল সম্পাদক ব্যবহার করে একটি নোড সম্পাদনা করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. আপনি সম্পাদনা করতে চান এমন API ডকুমেন্টেশনের সাথে সম্পর্কিত Drupal নোডে ব্রাউজ করুন।
3. ড্রুপাল সম্পাদক ব্যবহার করতে সম্পাদনা নির্বাচন করুন।
4. আপনার সম্পাদনা সম্পূর্ণ হওয়ার পরে, আপডেট পদ্ধতি নির্বাচন করুন।

বিকল্পভাবে, আপনি SmartDocs মডেল থেকে নোড সম্পাদনা করতে পারেন:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. নির্বাচন করুন বিষয়বস্তু > Drupal প্রশাসন মেনুতে SmartDocs।
3. আপনি যে মডেলটি আপডেট করতে চান তার জন্য, অপারেশনের অধীনে API রিভিশন নির্বাচন করুন।
4. আপনি প্রকাশ করতে চান মডেল সংশোধন নির্বাচন করুন.
5. আপনি যে পদ্ধতিটি সম্পাদনা করতে চান তার জন্য অপারেশন ড্রপডাউনে সম্পাদনা পদ্ধতি নির্বাচন করুন।

একটি নোড মুছে ফেলতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. নির্বাচন করুন বিষয়বস্তু > Drupal প্রশাসন মেনুতে SmartDocs।
3. আপনি যে মডেলটি আপডেট করতে চান তার জন্য, অপারেশনের অধীনে API রিভিশন নির্বাচন করুন।
4. আপনি প্রকাশ করতে চান মডেল সংশোধন নির্বাচন করুন.
5. পদ্ধতির জন্য অপারেশন ড্রপডাউনে মুছুন পদ্ধতি নির্বাচন করুন।
   সতর্কতা: নোড মুছে ফেলার ফলে মডেল থেকে API মুছে যায়। আপনি যদি শুধুমাত্র API এর প্রকাশনা প্রকাশ করতে চান যাতে এটি পোর্টাল ব্যবহারকারীদের কাছ থেকে লুকানো থাকে, কিন্তু মডেল থেকে এটি মুছে ফেলতে না চান, তাহলে উপরে বর্ণিত নোডের প্রকাশনা অপ্রকাশিত করা উচিত।

পোর্টালটিতে একটি অন্তর্নির্মিত প্রতিবেদন রয়েছে যা স্মার্টডকস মডেল দ্বারা রেন্ডার করা যেকোনো নোড সম্পর্কে তথ্য প্রদর্শন করে যা আর মডেলের বৈধ পদ্ধতির উল্লেখ করে না। ড্রুপাল মেনুতে রিপোর্ট নির্বাচন করে এবং তারপর SmartDocs নোড স্ট্যাটাস নামে রিপোর্ট নির্বাচন করে রিপোর্টটি অ্যাক্সেস করুন।

একটি মডেল রপ্তানি এবং আমদানি

SmartDocs আপনাকে একটি ফাইলে একটি বিদ্যমান মডেল রপ্তানি করতে দেয়। উদাহরণস্বরূপ, আপনি একটি উত্পাদন এবং একটি স্টেজিং পরিবেশ সংজ্ঞায়িত করতে পারেন। তারপরে আপনি স্টেজিং পরিবেশে আপনার সমস্ত SmartDocs সম্পাদনা করুন৷ আপনি যখন আপনার APIগুলি প্রকাশ করতে প্রস্তুত হন, আপনি স্টেজিং মডেলটি রপ্তানি করেন এবং এটি উত্পাদন মডেলে আমদানি করেন৷

একটি মডেল আমদানি করা মডেলটির একটি নতুন সংশোধন তৈরি করে। SmartDocs আমদানি করা API-এর সাথে মডেলে বিদ্যমান API-গুলিকে মেলানোর চেষ্টা করে৷ SmartDocs কোনো মিল শনাক্ত করলে, আমদানি বর্তমান API-এর সাথে সম্পর্কিত Drupal নোড আপডেট করে। যদি SmartDocs একটি মিল সনাক্ত না করে, তাহলে আমদানি API এর জন্য একটি নতুন Drupal নোড তৈরি করে।

উদাহরণস্বরূপ, আপনার কাছে একটি POST API আছে যা 91 এর একটি ID সহ একটি Drupal নোডের সাথে মিলে যায়৷ তারপর আপনি একটি মডেল আমদানি করেন এবং SmartDocs বিদ্যমান POST API-এর সাথে আমদানি করা মডেলে একটি POST API-এর মিল সনাক্ত করে৷ POST API-তে যেকোন আপডেট তারপর Drupal node 91 আপডেট করুন। SmartDocs যদি একটি মিল সনাক্ত না করে, তাহলে এটি একটি নতুন ID সহ একটি নতুন Drupal নোড তৈরি করে।

ড্রুপাল API এর নিম্নলিখিত বৈশিষ্ট্যগুলি ব্যবহার করে ম্যাচটি সম্পাদন করে:

• অভ্যন্তরীণ নাম : অভ্যন্তরীণ মডেলের নাম।
• httpMethod : API-এর HTTP পদ্ধতি, যেমন: GET, PUT, POST, বা DELETE।
• resourcePath : সম্পদ পথ।
• query params : API দ্বারা ব্যবহৃত যেকোন কোয়েরি প্যারামিটার।

যদি একটি আমদানি করা API-এর চারটি বৈশিষ্ট্যই মডেলের একটি বিদ্যমান API-এর সাথে মেলে, তাহলে SmartDocs বিদ্যমান ড্রুপাল নোড আপডেট করে।

রপ্তানি করা মডেলটি সম্পদ এবং পদ্ধতির জন্য এন্ট্রি সহ একটি একক JSON অবজেক্ট দ্বারা প্রতিনিধিত্ব করা হয়। এর মানে হল আপনি একটি সংস্থান বা পদ্ধতি পরিবর্তন করতে রপ্তানি করা মডেলটি সম্পাদনা করতে পারেন এবং তারপরে মডেলটি পুনরায় আমদানি করতে পারেন। আপনি যদি JSON অবজেক্টটি সম্পাদনা করেন তবে নিম্নলিখিত ক্ষেত্রগুলি পরিবর্তন করবেন না:

• পুনর্বিবেচনা নম্বর
• সৃষ্টির সময়
• পরিবর্তিত সময়
• apiRevisionId
• রিসোর্স আইডি

একটি মডেল রপ্তানি করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. Drupal অ্যাডমিনিস্ট্রেশন মেনুতে Content > SmartDocs নির্বাচন করুন।
3. আপনি যে মডেলটি রপ্তানি করতে চান তার জন্য, অপারেশনের অধীনে রপ্তানি নির্বাচন করুন।
4. SmartDocs JSON হিসাবে এক্সপোর্ট ফাইলের ধরন নির্বাচন করুন।
5. রপ্তানি ক্লিক করুন.
6. আপনাকে ফাইলটি ডিস্কে সংরক্ষণ করতে বা সম্পাদকে এটি খুলতে বলা হয়।

একটি মডেল আমদানি করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. Drupal অ্যাডমিনিস্ট্রেশন মেনুতে Content > SmartDocs নির্বাচন করুন।
3. আপনি যে মডেলটি আমদানি করতে চান তার জন্য, অপারেশনের অধীনে আমদানি নির্বাচন করুন।
4. Format ড্রপডাউনে SmartDocs JSON নির্বাচন করুন।
5. ফাইল বা URL নির্বাচন করুন আপলোডের ধরন:
   1. আপনি যদি ফাইল নির্বাচন করেন, JSON ফাইলে ব্রাউজ করুন।
   2. আপনি URL নির্বাচন করলে, SmartDocs JSON ফাইলের URL উল্লেখ করুন৷
6. মডেলে আমদানি করতে আমদানিতে ক্লিক করুন।
7. আপনাকে মডেলের তথ্য পৃষ্ঠায় পুনঃনির্দেশিত করা হয়েছে যেখানে আপনি এখন মডেলটি রেন্ডার করতে পারেন৷ নোট করুন যে আমদানি মডেলটির একটি নতুন সংশোধন তৈরি করে।
8. রেন্ডার এবং নোড প্রকাশ.

SmartDocs টেমপ্লেট সম্পাদনা করা হচ্ছে

SmartDocs টেমপ্লেট আপনার Drupal নোডগুলি স্ক্রিনে কীভাবে প্রদর্শিত হবে তা নির্ধারণ করে। প্রতিটি SmartDocs মডেল একই ডিফল্ট টেমপ্লেট ব্যবহার করতে পারে অথবা আপনি একটি পৃথক মডেলের জন্য ব্যবহৃত টেমপ্লেটটি ম্যানুয়ালি কাস্টমাইজ করতে পারেন।

SmartDocs টেমপ্লেটে একটি হ্যান্ডেলবার .hbr ফাইল, CSS ফাইল এবং জাভাস্ক্রিপ্ট ফাইল হিসাবে কোড করা একটি টেমপ্লেট ফাইল রয়েছে। হ্যান্ডেলবারগুলির সাথে, বেশিরভাগ বিষয়বস্তু এম্বেডেড হ্যান্ডেলবার এক্সপ্রেশন ব্যবহার করে পরিবর্তনশীল-চালিত হয়, যেমন &123;&123;body}} । বিদ্যমান হ্যান্ডেলবার এক্সপ্রেশনগুলির একটি তালিকা ফাইলের শীর্ষে একটি মন্তব্যে সরবরাহ করা হয়েছে। আপনার টেমপ্লেটগুলি কাস্টমাইজ করতে হ্যান্ডেলবার ব্যবহার করার বিষয়ে তথ্যের জন্য, http://handlebarsjs.com দেখুন।

নিম্নলিখিত বিভাগগুলি বর্ণনা করে যে সমস্ত নতুন মডেলের দ্বারা ব্যবহারের জন্য বা আপনি যখন একটি বিদ্যমান মডেলে নতুন API আমদানি করছেন তখন কীভাবে একটি কাস্টম SmartDocs টেমপ্লেট ফাইল আপলোড করবেন, কীভাবে আসল ডিফল্ট SmartDocs টেমপ্লেট ফাইলটি পুনরুদ্ধার করবেন এবং কীভাবে SmartDocs টেমপ্লেটটি পরিবর্তন করবেন স্বতন্ত্র মডেল।

একটি কাস্টম SmartDocs টেমপ্লেট ফাইল আপলোড করা হচ্ছে

আপনি একটি কাস্টম SmartDocs টেমপ্লেট ফাইল আপলোড করতে পারেন, একটি Handlebars .hbr ফাইল হিসাবে, নতুন মডেল তৈরি করার সময় বা বিদ্যমান মডেলে নতুন API আমদানি করার সময় ডিফল্ট টেমপ্লেট হিসাবে ব্যবহার করতে।

আপনি যদি আপনার কাস্টম SmartDocs টেমপ্লেট ফাইল তৈরি করার সময় একটি প্রারম্ভিক পয়েন্ট হিসাবে ডিফল্ট SmartDocs টেমপ্লেট ফাইল ব্যবহার করতে চান, তাহলে আপনি এখান থেকে একটি কপি ডাউনলোড করতে পারেন: profiles/apigee/modules/custom/devconnect/smartdocs/templates/smartdocs.hbr

একটি কাস্টম স্মার্টডোকস টেম্পলেট ফাইল আপলোড করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. দ্রুপাল প্রশাসনের মেনুতে কনফিগারেশন> স্মার্টডোকস নির্বাচন করুন।
3. পৃষ্ঠার উন্নত সেটিংস অঞ্চল প্রসারিত করুন।
4. কাস্টমাইজড পদ্ধতি টেম্পলেট আপলোডের অধীনে, ফাইলটি চয়ন করুন ক্লিক করুন এবং হ্যান্ডেলবারগুলিতে নেভিগেট করুন .hbr ফাইলে।
5. আপলোড ক্লিক করুন।
6. কনফিগারেশন সংরক্ষণ করুন ক্লিক করুন।

ডিফল্ট স্মার্টডোকস টেম্পলেট ফাইল পুনরুদ্ধার করা

আপনি ডিফল্ট স্মার্টডোকস টেম্পলেট ফাইলটি পুনরুদ্ধার করতে পারেন। একবার পুনরুদ্ধার হয়ে গেলে, নতুন মডেল তৈরি করার সময় বা বিদ্যমান মডেলটিতে নতুন এপিআই আমদানি করার সময় ডিফল্ট স্মার্টডোকস টেম্পলেট ফাইল ব্যবহার করা হবে।

ডিফল্ট স্মার্টডোকস টেম্পলেট ফাইলটি পুনরুদ্ধার করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. দ্রুপাল প্রশাসনের মেনুতে কনফিগারেশন> স্মার্টডোকস নির্বাচন করুন।
3. পৃষ্ঠার উন্নত সেটিংস অঞ্চল প্রসারিত করুন।
4. কাস্টমাইজড পদ্ধতি টেম্পলেট আপলোডের অধীনে, কাস্টম স্মার্টডোকস টেম্পলেট ফাইল সংলগ্ন সরান ক্লিক করুন।
5. কনফিগারেশন সংরক্ষণ করুন ক্লিক করুন।

একটি পৃথক মডেলের জন্য স্মার্টডোকস টেম্পলেট পরিবর্তন করা

আপনি একটি পৃথক মডেলের জন্য ব্যবহৃত টেমপ্লেটটি সংশোধন করতে পারেন।

একটি স্বতন্ত্র মডেলের জন্য টেমপ্লেটটি পরিবর্তন করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. দ্রুপাল প্রশাসন মেনুতে সামগ্রী> স্মার্টডোকস নির্বাচন করুন।
3. আপনি যে মডেলটি সম্পাদনা করতে চান তার জন্য, অপারেশনগুলির অধীনে সেটিংস নির্বাচন করুন।
4. পদ্ধতি টেম্পলেট অঞ্চলে, প্রয়োজনীয় হিসাবে টেমপ্লেটটি সম্পাদনা করুন।
5. টেমপ্লেট সংরক্ষণ করুন ক্লিক করুন।
6. একটি দ্রুপাল নোডে ব্রাউজ করুন। আপনার পৃষ্ঠায় আপনার টেম্পলেট পরিবর্তনগুলি দেখতে হবে।

স্মার্টডোকস প্রমাণীকরণের প্রকারটি কনফিগার করছে

স্মার্টডোকগুলিতে সংজ্ঞায়িত এপিআইগুলি হয় খোলা থাকতে পারে, যার অর্থ তাদের অ্যাক্সেস করার জন্য কোনও প্রমাণীকরণের শংসাপত্রের প্রয়োজন হয় না বা সুরক্ষিত হয়। একটি সুরক্ষিত এপিআই এর জন্য এপিআইতে কল করার সময় শংসাপত্রগুলি পাস করা প্রয়োজন।

একটি সুরক্ষিত এপিআইয়ের জন্য, স্মার্টডোকস নিম্নলিখিত ধরণের প্রমাণীকরণ সমর্থন করে:

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

প্রতিটি ধরণের প্রমাণীকরণের জন্য, আপনি একটি সুরক্ষা স্কিম তৈরি করেন যা প্রমাণীকরণের বৈশিষ্ট্যগুলি সংজ্ঞায়িত করে। উদাহরণস্বরূপ, কাস্টম টোকেন প্রমাণীকরণের জন্য, সুরক্ষা প্রকল্পটি কীভাবে টোকেনটি পাস করা হয় (শিরোনাম, ক্যোয়ারী প্যারাম, বডি প্যারাম) এবং টোকেনের নাম নির্ধারণ করে।

একটি সুরক্ষা স্কিম একটি মডেলের একটি নির্দিষ্ট সংশোধনের সাথে সম্পর্কিত। অতএব, আপনি যদি কোনও মডেলের নতুন সংশোধন তৈরি করেন তবে আপনাকে সেই সংশোধনীর জন্য সুরক্ষা প্রকল্পগুলি নতুন করে সংজ্ঞায়িত করতে হবে

একটি ডাব্লুএডিএল ফাইলে, আপনি যদি কোনও এপিআইকে <অ্যাপিগি: প্রমাণীকরণ> অ্যাপিগি ট্যাগ ব্যবহার করে প্রমাণীকরণের প্রয়োজন হয় তবে নীচে দেখানো হয়েছে:

<method id="statusespublic_timeline" name="GET" apigee:displayName="PublicTimeline">
    ...
    <apigee:authentication required="true"/>
</method> 

যদি এপিআই খোলা থাকে তবে প্রয়োজনীয় বৈশিষ্ট্যটিকে মিথ্যা হিসাবে সেট করুন।

লক্ষ্য করুন যে আপনি ডাব্লুএডিএল ফাইলটিতে প্রমাণীকরণের ধরণটি নির্দিষ্ট করতে পারবেন না। আপনি দ্রুপালে নোড সম্পাদনা করে এটি করেন। ডাব্লুএডিএল ফাইলগুলি সম্পর্কে আরও তথ্যের জন্য, ডাব্লুএডিএল রেফারেন্স দেখুন।

দ্রুপালের এপিআই পৃষ্ঠায়, স্মার্টডোকস ব্যবহারকারীদের তাদের বেসিক প্রমাণীকরণের শংসাপত্রগুলি নির্দিষ্ট করতে নিম্নলিখিত বোতামটি যুক্ত করে:

যদি আপনি প্রমাণীকরণের ধরণটি OAuth এ সেট করতে নোড সম্পাদনা করেন তবে স্মার্টডোকস পৃষ্ঠায় নিম্নলিখিত বোতামটি যুক্ত করে:

কাস্টম টোকেনের জন্য, স্মার্টডোকস যুক্ত করে:

বেসিক প্রমাণীকরণ কনফিগার করা

আপনি যদি আপনার এপিআইয়ের সাথে বেসিক প্রমাণীকরণ ব্যবহার করেন তবে আপনাকে কেবল মডেল তৈরি করতে ব্যবহার করা ডাব্লুএডিএল ফাইলটিতে <অ্যাপিগি: প্রমাণীকরণ> ট্যাগ নির্দিষ্ট করতে হবে।

ডাব্লুএডিএল ফাইল ব্যতীত অন্য উত্স থেকে তৈরি পদ্ধতিগুলিতে প্রাথমিক প্রমাণীকরণ প্রয়োগ করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. নির্বাচন করুন কন্টেন্ট> ড্রুপাল প্রশাসনের মেনুতে স্মার্টডোকস।
3. কাঙ্ক্ষিত মডেলের জন্য, অপারেশনগুলির অধীনে এপিআই সংশোধনগুলি নির্বাচন করুন।
4. মডেল রিভিশনের জন্য আপনি সম্পাদনা করতে চান, অপারেশনগুলির অধীনে সুরক্ষা সেটিংস নির্বাচন করুন।
5. সুরক্ষা স্কিম যুক্ত করুন নির্বাচন করুন।
6. সুরক্ষা প্রকল্পের নাম উল্লেখ করুন।
7. প্রকার হিসাবে বেসিক নির্বাচন করুন।
8. জমা দিন নির্বাচন করুন।
9. মডেলের প্রতিটি পদ্ধতির জন্য, এর সুরক্ষা স্কিমটি আপনার প্রাথমিক স্কিমে সেট করার পদ্ধতিটি সম্পাদনা করুন।
   1. নির্বাচন করুন কন্টেন্ট> ড্রুপাল প্রশাসনের মেনুতে স্মার্টডোকস।
   2. কাঙ্ক্ষিত মডেলের জন্য, অপারেশনগুলির অধীনে এপিআই সংশোধনগুলি নির্বাচন করুন।
   3. মডেল রিভিশনের জন্য আপনি সম্পাদনা করতে চান, অপারেশনগুলির অধীনে সংশোধন বিশদ নির্বাচন করুন।
   4. আপনি সম্পাদনা করতে চান এমন API এর জন্য সম্পাদনা পদ্ধতি নির্বাচন করুন।
   5. এপিআইয়ের জন্য সুরক্ষা প্রকল্পটি নির্বাচন করুন।
   6. এপিআই সংরক্ষণ করুন ।

OAuth 2.0 প্রমাণীকরণ কনফিগার করা

আপনি বেসিক প্রমাণীকরণের ডিফল্ট পরিবর্তে স্মার্টডোকগুলিতে OAuth 2.0 ব্যবহার করতে একটি মডেল কনফিগার করতে পারেন। আপনি দুটি স্থানে ওআউথ কনফিগার করুন:

1. পুনর্বিবেচনার জন্য সুরক্ষা সেটিংসের অধীনে কোনও মডেলের প্রতিটি সংশোধনের জন্য একটি সুরক্ষা স্কিম তৈরি করুন।
2. মডেলের জন্য সেটিংসের অধীনে মডেলের সমস্ত সংশোধনের জন্য ক্লায়েন্ট আইডি এবং ক্লায়েন্ট সিক্রেট নির্দিষ্ট করুন।

OAuth সক্ষম করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. নির্বাচন করুন কন্টেন্ট> ড্রুপাল প্রশাসনের মেনুতে স্মার্টডোকস।
3. কাঙ্ক্ষিত মডেলের জন্য, অপারেশনগুলির অধীনে এপিআই সংশোধনগুলি নির্বাচন করুন।
4. মডেল রিভিশনের জন্য আপনি সম্পাদনা করতে চান, অপারেশনগুলির অধীনে সুরক্ষা সেটিংস নির্বাচন করুন।
5. সুরক্ষা স্কিম যুক্ত করুন নির্বাচন করুন।
6. সুরক্ষা প্রকল্পের নাম উল্লেখ করুন।
7. প্রকার হিসাবে OAuth 2.0 নির্বাচন করুন।
8. অনুদানের ধরণ সেট করুন।
9. অনুমোদনের ইউআরএল ক্ষেত্রগুলিতে মানগুলি প্রবেশ করান। অনুমোদনের ইউআরএল অ্যাক্সেস টোকেন পেতে ব্যবহৃত হয়।
10. অনুমোদনের ক্রিয়াটি পেতে বা পোস্ট হিসাবে সেট করুন।
11. অ্যাক্সেস টোকেন ইউআরএল প্রবেশ করান। অ্যাক্সেস টোকেন ইউআরএল হ'ল ইউআরএল যা অ্যাক্সেস টোকেনের জন্য অনুরোধ টোকেন বিনিময় করতে ব্যবহৃত হয়।
12. অ্যাক্সেস টোকেন পরম নাম লিখুন।
13. টোকেন কীভাবে পাস করবেন তা নির্দিষ্ট করতে ব্যবহার করুন : শিরোনাম , ক্যোয়ারী বা বডি ।
14. OAuth স্কোপ সেট করুন।
15. জমা দিন নির্বাচন করুন।
16. নির্বাচন করুন কন্টেন্ট> ড্রুপাল প্রশাসনের মেনুতে স্মার্টডোকস।
17. মডেলটির জন্য, অপারেশনগুলি ড্রপ-ডাউনে সেটিংস নির্বাচন করুন।
18. ক্লায়েন্ট আইডি এবং ক্লায়েন্ট সিক্রেটে মানগুলি লিখুন।
19. টেমপ্লেট প্রমাণীকরণ সেটিংস সংরক্ষণ করুন নির্বাচন করুন।
20. মডেলের প্রতিটি পদ্ধতির জন্য, এর সুরক্ষা স্কিমটি আপনার OAuth সুরক্ষা প্রকল্পে সেট করার পদ্ধতিটি সম্পাদনা করুন।
    1. নির্বাচন করুন কন্টেন্ট> ড্রুপাল প্রশাসনের মেনুতে স্মার্টডোকস।
    2. কাঙ্ক্ষিত মডেলের জন্য, অপারেশনগুলির অধীনে এপিআই সংশোধনগুলি নির্বাচন করুন।
    3. মডেল রিভিশনের জন্য আপনি সম্পাদনা করতে চান, অপারেশনগুলির অধীনে সংশোধন বিশদ নির্বাচন করুন।
    4. আপনি সম্পাদনা করতে চান এমন API এর জন্য সম্পাদনা পদ্ধতি নির্বাচন করুন।
    5. এপিআইয়ের জন্য সুরক্ষা প্রকল্পটি নির্বাচন করুন।
    6. এপিআই সংরক্ষণ করুন ।

কাস্টম টোকেন প্রমাণীকরণ কনফিগার করা

আপনি কাস্টম টোকেন প্রমাণীকরণ ব্যবহার করতে একটি মডেল কনফিগার করতে পারেন।

কাস্টম টোকেন সক্ষম করতে:

1. প্রশাসক বা বিষয়বস্তু তৈরির সুবিধা সহ ব্যবহারকারী হিসাবে আপনার পোর্টালে লগ ইন করুন৷
2. নির্বাচন করুন কন্টেন্ট> ড্রুপাল প্রশাসনের মেনুতে স্মার্টডোকস।
3. কাঙ্ক্ষিত মডেলের জন্য, অপারেশনগুলির অধীনে এপিআই সংশোধনগুলি নির্বাচন করুন।
4. মডেল রিভিশনের জন্য আপনি সম্পাদনা করতে চান, অপারেশনগুলির অধীনে সুরক্ষা সেটিংস নির্বাচন করুন।
5. সুরক্ষা স্কিম যুক্ত করুন নির্বাচন করুন।
6. সুরক্ষা প্রকল্পের নাম উল্লেখ করুন।
7. টাইপ হিসাবে এপিকে নির্বাচন করুন।
8. টোকেনযুক্ত প্যারাম নামটি সেট করুন।
9. টোকেন কীভাবে পাস করবেন তা নির্দিষ্ট করতে ব্যবহার করুন : শিরোনাম , ক্যোয়ারী বা বডি ।
10. জমা দিন নির্বাচন করুন।
11. মডেলের প্রতিটি পদ্ধতির জন্য, আপনার টোকেন স্কিমটিতে তার সুরক্ষা স্কিম সেট করার পদ্ধতিটি সম্পাদনা করুন।
    1. নির্বাচন করুন কন্টেন্ট> ড্রুপাল প্রশাসনের মেনুতে স্মার্টডোকস।
    2. কাঙ্ক্ষিত মডেলের জন্য, অপারেশনগুলির অধীনে এপিআই সংশোধনগুলি নির্বাচন করুন।
    3. মডেল রিভিশনের জন্য আপনি সম্পাদনা করতে চান, অপারেশনগুলির অধীনে সংশোধন বিশদ নির্বাচন করুন।
    4. আপনি সম্পাদনা করতে চান এমন API এর জন্য সম্পাদনা পদ্ধতি নির্বাচন করুন।
    5. এপিআইয়ের জন্য সুরক্ষা প্রকল্পটি নির্বাচন করুন।
    6. এপিআই সংরক্ষণ করুন ।

একটি মডেল মুছে ফেলা হচ্ছে

আপনি যখন কোনও মডেল মুছে ফেলেন ( কন্টেন্ট> স্মার্টডোকস , দ্রুপালের অপারেশনস ক্ষেত্রে মুছে ফেলুন ), মডেলটি আপনার এজ সংস্থা থেকে মুছে ফেলা হয়। এর অর্থ যদি অন্য পোর্টালগুলি মডেলটি উল্লেখ করে থাকে তবে মডেলটি আর উপলভ্য নয়। আরও তথ্যের জন্য, স্মার্টডোক মডেল এবং টেমপ্লেটগুলি সম্পর্কে দেখুন।