API का दस्तावेज़ बनाने के लिए SmartDocs का इस्तेमाल करना

Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी

SmartDocs की मदद से, आपके एपीआई को Drupal 7 डेवलपर पोर्टल पर इस तरह से दर्ज किया जा सकता है कि एपीआई दस्तावेज़ पूरी तरह से इंटरैक्टिव हो जाएं. इंटरैक्टिव दस्तावेज़ का मतलब है कि पोर्टल के उपयोगकर्ता ये काम कर सकते हैं:

  • अपने एपीआई के बारे में पढ़ें
  • एपीआई को लाइव अनुरोध भेजना
  • एपीआई से मिला लाइव रिस्पॉन्स देखें

अपने एपीआई के लिए इंटरैक्टिव दस्तावेज़ बनाकर, पोर्टल का इस्तेमाल करने वाले लोगों के लिए, एपीआई के बारे में जानना, उनकी जांच करना, और उनका आकलन करना आसान बना दिया जाता है.

Edge मैनेजमेंट एपीआई एक RESTful API है, जो आपको किसी भी एचटीटीपी क्लाइंट का इस्तेमाल करके एपीआई सेवाओं को ऐक्सेस करने की सुविधा देता है. Apigee, Edge मैनेजमेंट एपीआई के लिए इंटरैक्टिव दस्तावेज़ बनाने के लिए, SmartDocs का इस्तेमाल करता है. एपीआई से जुड़े दस्तावेज़ यहां देखें.

SmartDocs पोर्टल का उदाहरण

SmartDocs की सुविधा का इस्तेमाल करने के लिए, आपके पास Apigee डेवलपर सर्विस का पोर्टल होना ज़रूरी है. ज़्यादा जानकारी के लिए, डेवलपर पोर्टल बनाना देखें.

अपने डेवलपर पोर्टल के होम पेज पर जाकर, एपीआई दस्तावेज़ पेज देखने के लिए, सबसे ऊपर मौजूद नेविगेशन बार में मौजूद एपीआई पर क्लिक करें.

पोर्टल पर दो एपीआई बताए गए हैं: Hello World और पालतू जानवरों की दुकान का उदाहरण.

Hello World API को, मॉक टारगेट OpenAPI स्पेसिफ़िकेशन, mocktarget.yaml से बनाया गया है. ज़्यादा जानकारी के लिए, https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi देखें.

पालतू जानवरों की दुकान का उदाहरण एपीआई, पालतू जानवरों की दुकान के क्लासिक वर्शन के डेमो से बनाया गया है.

Hello World API के बारे में ज़्यादा जानें:

  1. नमस्ते World API पर क्लिक करें. Hello World 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 का इस्तेमाल करके, एपीआई को दस्तावेज़ में दर्ज करने का तरीका

SmartDocs की मदद से, आपके एपीआई के बारे में जानकारी मिलती है. इसके लिए, model का इस्तेमाल किया जाता है. इस मॉडल में, आपके एपीआई के बारे में पूरी जानकारी होती है. पोर्टल आपके एपीआई के बारे में जानकारी निकालता है, ताकि पोर्टल पर दस्तावेज़ पेजों को Drupal नोड के रूप में रेंडर किया जा सके, जहां हर Drupal नोड पोर्टल के दस्तावेज़ के पेज से मेल खाता है.

SmartDocs की सुविधा का इस्तेमाल करने के लिए, ये सामान्य तरीके अपनाए जाते हैं:

  1. पोर्टल पर Drupal SmartDocs की सुविधा के मॉड्यूल को कॉन्फ़िगर करें.
  2. SmartDocs का मॉडल बनाएं.
  3. WADL फ़ाइल, OpenAPI (पहले इसे स्वैगर के नाम से जाना जाता था) की खास जानकारी से या मैन्युअल तरीके से, मॉडल में एपीआई जोड़ें.
  4. मॉडल को Drupal नोड के कलेक्शन के तौर पर रेंडर करें. हर Drupal नोड में एक एपीआई के बारे में जानकारी होती है. उदाहरण के लिए, अगर आपके एपीआई में मौजूद कोई संसाधन POST और PUT अनुरोध, दोनों के साथ काम करता है, तो SmartDocs, POST और PUT के लिए अलग से Drupal नोड बनाता है.
  5. Drupal नोड को पब्लिश करें. पब्लिश होने के बाद, पोर्टल के उपयोगकर्ता आपके एपीआई को देख सकते हैं और उसके साथ इंटरैक्ट कर सकते हैं.
  6. Drupal नोड को पब्लिश करने से पहले या बाद में बदलाव करें. Drupal एडिटर का इस्तेमाल करके या मूल WADL फ़ाइल या OpenAPI स्पेसिफ़िकेशन में बदलाव करके, Drupal नोड में बदलाव किया जा सकता है. WADL फ़ाइल या OpenAPI स्पेसिफ़िकेशन में बदलाव करने के बाद, इसे नए बदलाव के तौर पर वापस मॉडल में इंपोर्ट करें. इसके बाद, बदलावों को रेंडर करें और पब्लिश करें.
  7. TLS चालू करें. SmartDocs की मदद से आपके एपीआई को अनुरोध करते समय, बैकएंड को पुष्टि करने के क्रेडेंशियल भेजे जा सकते हैं. इसलिए, आपको अपने पोर्टल पर TLS चालू करना चाहिए, ताकि यह पक्का किया जा सके कि वे क्रेडेंशियल सुरक्षित हैं. पोर्टल प्रोडक्शन और टेस्ट एनवायरमेंट में, Apigee, https:// अनुरोध करने के लिए ज़रूरी TLS सर्टिफ़िकेट देता है. हालांकि, अपने पोर्टल पर लाइव जाने से पहले, आपको अपना TLS सर्टिफ़िकेट हासिल करना होगा और TLS चालू करना होगा. ज़्यादा जानकारी के लिए, पोर्टल पर TLS का इस्तेमाल करना देखें.

SmartDoc मॉडल और टेंप्लेट के बारे में जानकारी

पोर्टल में कोई मॉडल बनाने पर, वह मॉडल आपके Edge संगठन में सेव हो जाता है, न कि Drupal में. मॉडल, JSON का एक बड़ा ब्लॉक होता है. इसका इंटरनल नाम (जैसे, "my-Smartdocs-api") होता है और यह एपीआई के स्ट्रक्चर के बारे में बताता है. वहीं दूसरी ओर, आपका पोर्टल, मॉडल को एचटीएमएल में रेंडर करता है और मॉडल के लिए एडिटिंग इंटरफ़ेस उपलब्ध कराता है. पोर्टल में एपीआई के कोई भी अपडेट, सोर्स मॉडल में अपने-आप वापस चले जाते हैं.

संगठन में सेव किए गए

Drupal में सेव किए गए

मॉडल

टेम्प्लेट

बदलाव करने की सुविधा के साथ Drupal नोड

मान लें कि आपके संगठन में एक से ज़्यादा पोर्टल हैं (उदाहरण के लिए, डेव, स्टेज, और प्रोडक्शन). Pantheon में जाकर, पोर्टल को एक एनवायरमेंट से दूसरे एनवायरमेंट में ले जाया जाता है. पोर्टल के हर इंस्टेंस का अपना एक मॉडल दिखता है, लेकिन वे सभी सोर्स मॉडल के बारे में बता रहे हैं. अगर डेवलपर में एपीआई में बदलाव किया जाता है, तो मॉडल अपडेट हो जाता है और बदलाव प्रोडक्शन में दिखते हैं. इसी तरह, अगर डेव में किसी मॉडल को मिटाया जाता है, तो सोर्स मिट जाता है और अब यह प्रोडक्शन में उपलब्ध नहीं होता.

टेंप्लेट, आपके SmartDocs के लुक और स्टाइल को कंट्रोल करते हैं. साथ ही, वे टेंप्लेट (जिन्हें हैंडलबार और सीएसएस फ़ाइलों से कंट्रोल किया जाता है) हर पोर्टल इंस्टेंस के साथ सेव किए जाते हैं. इसलिए, सैद्धांतिक तौर पर, हर पोर्टल हर मॉडल के लिए एक खास टेंप्लेट का इस्तेमाल कर सकता है. हालांकि, रेंडरिंग फ़्रेमवर्क की एक सुविधा यह भी है कि हर मॉडल पर डिफ़ॉल्ट टेंप्लेट अपने-आप लागू हो जाता है. डिफ़ॉल्ट टेंप्लेट, 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. Drupal एडमिन मेन्यू में मॉड्यूल चुनें. इंस्टॉल किए गए सभी Drupal मॉड्यूल की सूची दिखती है.
  3. SmartDocs मॉड्यूल चालू करें.
  4. कॉन्फ़िगरेशन को सेव करें.
  5. Drupal एडमिन मेन्यू में मॉड्यूल चुनें.
  6. SmartDocs -> अनुमतियां चुनें और पक्का करें कि "एडमिन" की भूमिका के लिए, SmartDocs मॉड्यूल के लिए एडमिन से जुड़े टास्क करें" चालू हो.
  7. Drupal के एडमिन मेन्यू में, कॉन्फ़िगरेशन > डेव पोर्टल चुनें.
  8. कनेक्शन टाइम आउट और अनुरोध टाइम आउट को 16 सेकंड पर सेट करें.
  9. कॉन्फ़िगरेशन को सेव करें.
  10. यूआरएल की सेटिंग कॉन्फ़िगर करें:
    1. Drupal मेन्यू से कॉन्फ़िगरेशन > खोज और मेटाडेटा > यूआरएल के उपनाम > सेटिंग चुनें.
    2. उपनाम की ज़्यादा से ज़्यादा लंबाई और कॉम्पोनेंट की ज़्यादा से ज़्यादा लंबाई को 255 पर सेट करें.
    3. विराम चिह्न को बड़ा करें.
    4. लेफ़्ट कर्ली ब्रैकेट ({) और राइट कर्ली ब्रैकेट (}) सेटिंग के लिए, कोई कार्रवाई नहीं (बदलें नहीं) चुनें.
    5. कॉन्फ़िगरेशन सेव करें पर क्लिक करें.
  11. अगर आपका डेवलपर पोर्टल बिना इंटरनेट ऐक्सेस किए, किसी इंटरनल नेटवर्क पर लोगों को दिख सकता है या आपके एपीआई का कोई सबसेट, निजी नेटवर्क पर है, तो SmartDocs API के प्रॉक्सी यूआरएल को कॉन्फ़िगर करें.
    1. Drupal एडमिन मेन्यू में कॉन्फ़िगरेशन > SmartDocs चुनें.
    2. बेहतर सेटिंग को बड़ा करें.
    3. SmartDocs के प्रॉक्सी यूआरएल फ़ील्ड को अपडेट करने के लिए, यहां दिया गया तरीका अपनाएं: <host>/smartdocs/v1/sendrequest.
      इनलाइन सहायता में आपके एनवायरमेंट के हिसाब से ज़रूरी वैल्यू दी जानी चाहिए. उदाहरण के लिए:
      https://api-us-east-1-enterprise.apigee.com/smartdocs/v1/sendrequest

      यह फ़ील्ड डिफ़ॉल्ट रूप से https://apiconsole-prod.apigee.net/smartdocs/v1/sendrequest पर सेट होता है
    4. कॉन्फ़िगरेशन सेव करें पर क्लिक करें.

मॉडल बनाना

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

हर मॉडल में एक यूनीक इंटरनल नाम होता है, जो जनरेट किए गए Drupal नोड के बेस यूआरएल के बारे में बताता है. हर Drupal नोड का यूआरएल इस तरह का होता है:

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

कहां:

  • drupalBasePath: आपके पोर्टल का बेस यूआरएल.
  • internalName: मॉडल का आंतरिक नाम.
  • httpMethod: एपीआई का एचटीटीपी तरीका. जैसे: पाएं, डालें, पोस्ट करें या मिटाएं.
  • resourcePath: संसाधन पाथ.

उदाहरण के लिए, अगर इंटरनल नाम को 'mymodel' के तौर पर दिखाया जाता है, तो '/books' नाम के संसाधन के लिए GET अनुरोध के लिए जनरेट किए गए Drupal नोड के यूआरएल का यूआरएल इस तरह होगा:

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

मॉडल बनाने के लिए

मॉडल बनाने पर, यह आपके Edge संगठन में एपीआई स्ट्रक्चर के सोर्स के तौर पर सेव हो जाता है. ज़्यादा जानकारी के लिए, SmartDoc मॉडल और टेंप्लेट के बारे में जानकारी देखें.

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal एडमिन मेन्यू में कॉन्टेंट > SmartDocs चुनें.
  3. पेज पर सबसे ऊपर मौजूद, नया मॉडल चुनें.
  4. ये फ़ील्ड डालें:
    • नाम: मॉडल का नाम, जो पूरी साइट पर दिखाया जाएगा.
    • अंदरूनी नाम: नाम टाइप करते ही, संगठन का नाम दिखने लगता है. मॉडल का इंटरनल नाम, जो सभी मॉडल के बीच यूनीक होना चाहिए. अंदरूनी नाम में सिर्फ़ अंग्रेज़ी के छोटे अक्षर, संख्याएं, और हाइफ़न शामिल होने चाहिए. इनके बीच में स्पेस नहीं होना चाहिए. इस नाम में बदलाव करने के लिए, बदलाव करें चुनें.
    • जानकारी: मॉडल का ब्यौरा.
  5. मॉडल बनाएं चुनें.

मॉडल बनाने के बाद, आपको मॉडल के पेज पर रीडायरेक्ट कर दिया जाता है. वहां से, आप ऑपरेशन ड्रॉप-डाउन bx का इस्तेमाल इन कामों के लिए कर सकते हैं:

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

मॉडल में एपीआई जोड़ना

किसी मॉडल में एपीआई जोड़ने के लिए, ये तरीके अपनाएं:

  • एपीआई की परिभाषा वाली WADL फ़ाइल इंपोर्ट की जा रही है
  • OpenAPI निर्देश इंपोर्ट करना (OpenAPI 2.0 या 1.2)
  • मैन्युअल तरीके से संसाधन और तरीके बनाना

आपके पास SmartDocs की JSON फ़ाइल को मॉडल में भी इंपोर्ट करने का विकल्प होता है. आम तौर पर, यह फ़ाइल पहले किसी मौजूदा मॉडल को एक्सपोर्ट करके, फ़ाइल में बदलाव करके, और फिर अपडेट को इंपोर्ट करके बनाई जाती है. ज़्यादा जानकारी के लिए, नीचे दिया गया "मॉडल एक्सपोर्ट और इंपोर्ट करना" देखें.

वीडियो: OpenAPI स्पेसिफ़िकेशन को इंपोर्ट करके, SmartDocs के मॉडल में एपीआई जोड़ने का तरीक़ा जानने के लिए, यह छोटा वीडियो देखें.

डब्ल्यूएडीएल इंपोर्ट करना

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

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal के एडमिन मेन्यू में कॉन्टेंट > SmartDocs चुनें.
  3. वह मॉडल चुनें जिसे आपको अपडेट करना है.
  4. ऑपरेशन में जाकर, इंपोर्ट करें चुनें.
  5. SmartDocs के इंपोर्ट पेज पर, फ़ॉर्मैट चुनें ड्रॉपडाउन में WADL चुनें.
  6. अपलोड का टाइप ड्रॉपडाउन से, फ़ाइल या यूआरएल चुनें.
    1. अगर आपने फ़ाइल चुना है, तो WADL फ़ाइल ब्राउज़ करें.
    2. अगर आपने यूआरएल चुना है, तो WADL फ़ाइल का यूआरएल बताएं.
  7. इसे मॉडल में इंपोर्ट करने के लिए, इंपोर्ट करें पर क्लिक करें. अब मॉडल को रेंडर किया जा सकता है.
  8. आपको मॉडल के जानकारी वाले पेज पर रीडायरेक्ट किया जाता है. यहां अब मॉडल को रेंडर किया जा सकता है.

OpenAPI की जानकारी इंपोर्ट करना

मॉडल बनाने के बाद, OpenAPI (पहले इसे स्वैगर के नाम से जाना जाता था) स्पेसिफ़िकेशन को इंपोर्ट किया जा सकता है. Edge, OpenAPI के वर्शन 1.2 और 2.0 के साथ काम करता है.

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

OpenAPI स्पेसिफ़िकेशन इंपोर्ट करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal एडमिन मेन्यू में कॉन्टेंट > SmartDocs चुनें.
  3. वह मॉडल चुनें जिसे आपको अपडेट करना है.
  4. ऑपरेशन में जाकर, इंपोर्ट करें चुनें.
  5. SmartDocs इंपोर्ट पेज पर फ़ॉर्मैट चुनें ड्रॉपडाउन में जाकर, Swagger JSON या Swagger YAML चुनें.
  6. अपलोड टाइप ड्रॉपडाउन में फ़ाइल या यूआरएल चुनें (OpenAPI 1.2 के लिए आपको यूआरएल चुनना होगा).
    1. अगर आपने फ़ाइल चुना है, तो OpenAPI स्पेसिफ़िकेशन ब्राउज़ करें.
    2. अगर यूआरएल चुना जाता है, तो OpenAPI स्पेसिफ़िकेशन का यूआरएल बताएं.
  7. इसे मॉडल में इंपोर्ट करने के लिए, इंपोर्ट करें पर क्लिक करें.
  8. आपको मॉडल के जानकारी वाले पेज पर रीडायरेक्ट किया जाता है. यहां अब मॉडल को रेंडर किया जा सकता है.

मैन्युअल तरीके से संसाधन और तरीके बनाना

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

एपीआई को मैन्युअल तरीके से जोड़ने के लिए:

  1. मॉडल का एक नया संशोधन बनाएं.

    बदलाव करते समय, मॉडल में सभी एपीआई के लिए सिंगल बेस पाथ तय किया जाता है. इसका मतलब है कि मॉडल में मौजूद सभी एपीआई के लिए, एक ही बेस पाथ बनाया जाता है. उदाहरण के लिए, बेस पाथ को इस तरह बताएं:

    https://myCompany.com/v1

    मॉडल में संसाधन जोड़ने पर, वे बेस पाथ को बढ़ा देते हैं.
  2. मॉडल के लिए एक या उससे ज़्यादा रिसॉर्स तय करें. रिसॉर्स पाथ, मॉडल में बदलाव के बेस पाथ के साथ जुड़ जाता है, ताकि रिसॉर्स के पूरे यूआरएल के बारे में जानकारी दी जा सके. उदाहरण के लिए, अगर आपका रिसॉर्स "/login" का पाथ तय करता है, तो संसाधन का पूरा यूआरएल यह होगा:

    https://myCompany.com/v1/login
  3. हर संसाधन के लिए एक या उससे ज़्यादा तरीके बताएं. एक तरीका ऐसी एचटीटीपी कार्रवाई के बारे में बताता है जिसे किसी संसाधन पर शुरू किया जा सकता है. उदाहरण के लिए, "/login" संसाधन के लिए, लॉगिन के लिए POST और लॉग आउट के लिए DELETE का इस्तेमाल किया जा सकता है. यह संसाधन अन्य HTTP क्रियाओं, जैसे कि PUT या GET के साथ काम नहीं करता. इसलिए, संसाधन के लिए दो तरीके तय करें, एक POST के लिए और दूसरा DELETE के लिए.

    यह तरीका, अपने पैरंट रिसॉर्स के संसाधन यूआरएल का इस्तेमाल करता है. इसलिए, एक ही यूआरएल वाले सभी तरीके, SmartDocs में एक ही संसाधन के तहत तय किए जाते हैं.

सामान्य नियम के तौर पर:

  • एपीआई में मौजूद हर यूनीक बेस पाथ के लिए, अलग SmartDocs का मॉडल बनाएं.
  • आपके एपीआई में मौजूद हर यूनीक संसाधन के लिए, SmartDocs के अलग संसाधन तय करें.
  • किसी संसाधन के साथ काम करने वाली हर एचटीटीपी कार्रवाई के लिए, SmartDocs की अलग-अलग तरीका तय करें.

मॉडल का नया संशोधन बनाना

आपके पास संसाधन को सिर्फ़ मॉडल के किसी मौजूदा बदलाव में जोड़ने का विकल्प होता है. अगर मॉडल में पहले से ही कोई बदलाव किया गया है, तो आपके पास अपना संसाधन जोड़ने का विकल्प होता है. अगर मॉडल नया है और उसमें कोई बदलाव नहीं किया गया है, तो नया बदलाव करें.

किसी मॉडल में नया बदलाव करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal के एडमिन मेन्यू में कॉन्टेंट > SmartDocs चुनें.
  3. जिस मॉडल को अपडेट करना है उसके लिए ऑपरेशन में जाकर, बदलाव जोड़ें को चुनें.
  4. एपीआई में बदलाव जोड़ें पेज पर, यह जानकारी डालें:
    • डिसप्ले नेम: संशोधन का वह नाम जो पोर्टल में दिखता है.
    • वर्शन आईडी: बदलाव के लिए एक छोटा आइडेंटिफ़ायर.
    • जानकारी: बदलाव का ब्यौरा.
    • बेसिक यूआरएल: मॉडल में बदलाव किए गए सभी एपीआई का बेस यूआरएल. किसी मॉडल में हर बार बदलाव के लिए, अलग-अलग बेस यूआरएल का इस्तेमाल किया जा सकता है. उदाहरण के लिए, बेस यूआरएल में वर्शन इंंडिकेटर शामिल किया जाता है. मॉडल में पहले बदलाव के लिए, इसका बेस यूआरएल यह है:
      https://myCompany.com/v1
      अगले बदलाव के लिए, बेस यूआरएल यह हो सकता है:
      https://myCompany.com/v2
  5. बदलाव जोड़ें चुनें. आपको मॉडल के संशोधन पेज पर रीडायरेक्ट कर दिया जाता है. अब आप मॉडल पर संसाधन तय कर सकते हैं.

संसाधन की परिभाषा

संसाधन, एपीआई के पूरे यूआरएल के बारे में बताता है. संसाधन की जानकारी देते समय, संसाधन का पाथ बताया जाता है. इसे मॉडल रिविज़न में बेस यूआरएल के साथ जोड़ा जाता है, ताकि संसाधन का पूरा यूआरएल बनाया जा सके.

संसाधन तय करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal के एडमिन मेन्यू में कॉन्टेंट > SmartDocs को चुनें.
  3. आपको जिस मॉडल को अपडेट करना है उसके सभी बदलाव देखने के लिए, ऑपरेशन में एपीआई में बदलाव चुनें.
  4. बदलाव करने के लिए कोई बदलाव चुनें.
  5. संशोधन पेज पर, ड्रॉपडाउन मेन्यू से संसाधन जोड़ें चुनें.
  6. संसाधन जोड़ें पेज पर, यह जानकारी डालें:
    • डिसप्ले नेम: संसाधन का नाम.
    • पाथ: संसाधन का पाथ, जो "/" से शुरू होता है. संसाधन का पूरा यूआरएल बनाने के लिए, पाथ की वैल्यू को मॉडल में बदलाव के बेस यूआरएल के साथ जोड़ दिया जाता है.
    • जानकारी: संसाधन का ब्यौरा.
    • पैरामीटर: विकल्प के तौर पर, संसाधन पर हर पैरामीटर की जानकारी देने वाला JSON ऑब्जेक्ट डालें. इन पैरामीटर के बारे में नीचे बताया गया है.
  7. संसाधन जोड़ें को चुनें. आपको मॉडल पेज पर रीडायरेक्ट कर दिया जाता है. अब संसाधन पर तरीके तय किए जा सकते हैं.

इसके अलावा, संसाधन में टेंप्लेट, क्वेरी, और हेडर पैरामीटर जैसे पैरामीटर जोड़े जा सकते हैं. सभी संसाधन पैरामीटर, उस संसाधन पर बताए गए किसी भी तरीके से इनहेरिट किए जाते हैं. इसलिए, अगर किसी संसाधन पर कोई क्वेरी पैरामीटर तय किया जाता है, तो उस संसाधन में जोड़े गए सभी तरीके, उस क्वेरी पैरामीटर के साथ काम करने वाले होने चाहिए.

इसके अलावा, किसी तरीके में पैरामीटर तय किए जा सकते हैं. उदाहरण के लिए, हो सकता है कि POST का तरीका ऐसे क्वेरी पैरामीटर के साथ काम करे जो DELETE तरीके के साथ काम न करते हों. इसलिए, किसी तरीके को तय करते समय उस तरीके के लिए कोई खास पैरामीटर जोड़ें. इसका तरीका नीचे बताया गया है.

नीचे दी गई इमेज में, हर तरह के पैरामीटर हाइलाइट किए गए Apigee स्वीकार या रद्द करें एपीआई के लिए मौजूदा SmartDocs पेज दिखाया गया है:

हर तरह के पैरामीटर को JSON ऑब्जेक्ट से तय किया जाता है:

Type

JSON ऑब्जेक्ट

ज़रूरी जानकारी

टेंप्लेट

{
"dataType": "string",
"defaultValue": "",
"description": "संगठन का नाम.",
"name": "org_name",
"ज़रूरी": सही,
"type": "template"
}

टेंप्लेट पैरामीटर हमेशा ज़रूरी होते हैं. इसलिए, require को true पर सेट करें और वैल्यू को defaultValue में छोड़ दें.

जब लोग SmartDocs पेज में यूआरएल पर कर्सर घुमाते हैं, तब description वैल्यू पॉप-अप में दिखती है.

क्वेरी

{
"dataType": "string",
"defaultValue": "",
"description": "जगह की जानकारी.",
"name": "w",
"ज़रूरी है": सही,
"type": "QUERY"
}

ज़रूरी क्वेरी पैरामीटर अब भी defaultValue तय कर सकते हैं, लेकिन अक्सर ऐसा नहीं करते.

वैकल्पिक क्वेरी पैरामीटर के लिए, ज़रूरी को गलत पर सेट करें और defaultValue के लिए एक मान तय करें.

हेडर

{
"dataType": "string",
"defaultValue": "application/json",
"description": "इसके रूप में बताएं <code>application/json</code>.",
"name": "Content-Type",
"ज़रूरी": सही,
"type": "हेडर"
}

ध्यान दें कि ब्यौरे में एचटीएमएल टैग का इस्तेमाल किस तरह किया जा सकता है.

टेंप्लेट पैरामीटर, रिसॉर्स पाथ में वैरिएबल को तय करता है. उदाहरण के लिए, किसी संसाधन पर दो टेंप्लेट पैरामीटर तय किए जाते हैं. देखें कि पैरामीटर कलेक्शन में मौजूद पैरामीटर की हर परिभाषा को कॉमा लगाकर कैसे अलग किया जाता है:

[
 {
  "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 पेज में जाकर, अनुरोध सबमिट करने से पहले उपयोगकर्ता को यूआरएल में बदलाव करके, यूआरएल के org_name और developer_email हिस्से की जानकारी देनी होगी.

कोई तरीका तय करना

हर संसाधन के लिए एक या उससे ज़्यादा तरीके बताएं. तरीके की परिभाषा एक एचटीटीपी क्रिया के बारे में बताती है जिसे संसाधन पर शुरू किया जा सकता है. किसी संसाधन के लिए, सिर्फ़ एक तरीका या कई तरीके बताए जा सकते हैं.

तरीका तय करते समय, ऐसे पैरामीटर तय करें जिनका इस्तेमाल तरीका करता हो. इनमें क्वेरी और हेडर पैरामीटर भी शामिल हैं. किसी तरीके में पैरामीटर जोड़ने के बारे में जानने के लिए, ऊपर दी गई जानकारी देखें.

नीचे दी गई इमेज में, Apigee Create Developer API के लिए मौजूदा SmartDocs पेज दिखाया गया है. इसमें पेज के हर उस हिस्से को दिखाया गया है जिसे तरीका तय करते समय सेट की गई वैल्यू के साथ हाइलाइट किया गया है:

अगली इमेज भी वही पेज दिखाती है. हालांकि, इसमें अनुरोध के मुख्य हिस्से में दी गई जानकारी को चुना गया है:

तरीका तय करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal के एडमिन मेन्यू में कॉन्टेंट > SmartDocs चुनें.
  3. आपको जिस मॉडल को अपडेट करना है उसके सभी बदलाव देखने के लिए, ऑपरेशन में एपीआई में बदलाव चुनें.
  4. बदलाव करने के लिए कोई बदलाव चुनें.
  5. बदलाव वाले पेज पर, किसी एक संसाधन के लिए ड्रॉपडाउन मेन्यू में जाकर, तरीका जोड़ें चुनें.
  6. बदलाव के तरीके पेज पर, यह जानकारी डालें:
    • डिसप्ले नेम: एपीआई का नाम, जो एपीआई के लिए Drupal पेज का टाइटल भी बन जाता है.
    • ब्यौरा: एपीआई के बारे में बताएं.
    • तरीका कार्रवाई: एचटीटीपी कार्रवाई का टाइप.
    • सुरक्षा स्कीम: अगर तरीका है, तो पुष्टि करने का मोड बताएं. ज़्यादा जानकारी के लिए, SmartDocs की पुष्टि करने के तरीके को कॉन्फ़िगर करना देखें.
    • कॉन्टेंट टाइप: अनुरोध और उसके जवाब का कॉन्टेंट टाइप. पुष्टि करने के अलग-अलग तरीके कॉन्फ़िगर करने के बारे में जानने के लिए, नीचे दिया गया सेक्शन देखें.
    • पैरामीटर: (ज़रूरी नहीं) तरीके के लिए कोई भी क्वेरी या हेडर पैरामीटर. ज़्यादा जानकारी के लिए, संसाधन में पैरामीटर जोड़ने के लिए, ऊपर दी गई जानकारी देखें.
    • अनुरोध के मुख्य हिस्से का दस्तावेज़: (ज़रूरी नहीं) अनुरोध के मुख्य हिस्से के बारे में बताएं. POST और PUT तरीके, अनुरोध के मुख्य हिस्से में शामिल होते हैं. इस बारे में बताने के लिए, इस हिस्से का इस्तेमाल किया जा सकता है. अगर इस वैल्यू को छोड़ा जाता है, तो अनुरोध का मुख्य हिस्सा में मौजूद जानकारी का लिंक, जनरेट किए गए SmartDocs के पेज से हटा दिया जाता है.
    • अनुरोध के मुख्य हिस्से का उदाहरण: (ज़रूरी नहीं) अनुरोध के मुख्य हिस्से का उदाहरण दिखाएं. आम तौर पर, इसे JSON ऑब्जेक्ट या एक्सएमएल के तौर पर दिखाया जाता है. POST और PUT कार्रवाइयों के लिए, अनुरोध के मुख्य हिस्से का उदाहरण, हर अनुरोध के हिस्से के तौर पर पास किया जाता है. एपीआई को अनुरोध सबमिट करने से पहले, SmartDocs पेज के उपयोगकर्ता इस उदाहरण में बदलाव करते हैं. अगर इस वैल्यू को छोड़ दिया जाता है, तो अनुरोध का मुख्य हिस्सा में मौजूद वैल्यू लिंक को, जनरेट किए गए SmartDocs के पेज से हटा दिया जाता है.
    • टैग: एपीआई से जुड़े टैग की कैटगरी. SmartDocs, मिलते-जुलते एपीआई को एक साथ ग्रुप करने के लिए टैग का इस्तेमाल करता है. उदाहरण के लिए, आंकड़ों से जुड़े सभी एपीआई पर "आंकड़े" टैग लागू किया जा सकता है. अलग-अलग संसाधनों के एपीआई को एक ही टैग से ग्रुप में बांटा जा सकता है. अगर वे सभी एक ही टैग का इस्तेमाल करते हैं.
  7. तरीका जोड़ें चुनें. आपको मॉडल पेज पर रीडायरेक्ट कर दिया जाता है. अब आपके पास अपने तरीके को रेंडर और पब्लिश करने का विकल्प है.

मॉडल रेंडर करना

किसी मॉडल में एपीआई जोड़ने के बाद, मॉडल को रेंडर किया जा सकता है. रेंडर करने से, एपीआई के मॉडल के ब्यौरे को Drupal नोड में बदल दिया जाता है. रेंडरिंग पूरी होने के बाद, आपके पास हर एपीआई के लिए एक Drupal नोड होगा. इसमें हर Drupal नोड किसी एचटीएमएल पेज से जुड़ा होता है.

पूरे मॉडल को एक बार में रेंडर किया जा सकता है या रेंडरिंग के लिए, अलग-अलग एपीआई को चुना जा सकता है.

मॉडल रेंडर करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal के एडमिन मेन्यू में कॉन्टेंट > SmartDocs चुनें.
  3. जिस मॉडल को आपको रेंडर करना है उसके लिए, ऑपरेशंस सेक्शन में एपीआई में बदलाव चुनें.
  4. वह बदलाव चुनें जिसे आपको रेंडर करना है. सिर्फ़ उस मॉडल के एक बदलाव से नोड रेंडर किए जा सकते हैं.
  5. रेंडर करने के तरीके चुनें.
  6. अपडेट विकल्प ड्रॉपडाउन से, रेंडर नोड चुनें.
  7. अपडेट करें पर क्लिक करें.
  8. आपको लोड हो रही स्क्रीन पर, रेंडर किए जा रहे नोड की प्रोग्रेस दिखेगी.
    नोड रेंडर होने के बाद, हर एपीआई के लिए Drupal नोड का आईडी, मॉडल के नोड असोसिएशन कॉलम में दिखता है. रेंडर किए गए नोड को देखने के लिए, नोड असोसिएशन कॉलम में दिए गए लिंक पर क्लिक करें.

रेंडर नोड चुनने के बजाय, एपीआई को रेंडर करने और तुरंत Drupal नोड के तौर पर पब्लिश करने के लिए, नोड रेंडर करें और पब्लिश करें को चुनें.

पब्लिश करने के लिए नोड

पोर्टल के उपयोगकर्ताओं को नोड तब तक नहीं दिखता, जब तक उसे पब्लिश नहीं किया जाता. रेंडर करने की प्रोसेस के दौरान, नोड को पब्लिश करने का विकल्प भी चुना जा सकता है. अगर आपने नोड को पब्लिश नहीं करने का विकल्प चुना है, तो रेंडरिंग पूरी होने के बाद, आपको उन्हें मैन्युअल तरीके से पब्लिश करना होगा.

नोड को पब्लिश करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal के एडमिन मेन्यू में कॉन्टेंट > SmartDocs को चुनें.
  3. आपको जिस मॉडल को पब्लिश करना है उसके लिए, ऑपरेशन में जाकर एपीआई में बदलाव चुनें.
  4. वह संशोधन चुनें जिसे आप प्रकाशित करना चाहते हैं. सिर्फ़ उस मॉडल के किसी एक बदलाव से नोड पब्लिश किए जा सकते हैं.
  5. पब्लिश करने के तरीके चुनें.
  6. पब्लिश करने के लिए, बदलाव में नोड चुनें.
  7. अपडेट विकल्प ड्रॉपडाउन से, पब्लिश करने के नोड चुनें.
  8. अपडेट करें पर क्लिक करें.
  9. नोड असोसिएशन कॉलम में, नोड आईडी चुनकर नोड पर जाएं.

डिफ़ॉल्ट रूप से, पब्लिश किए गए एपीआई नोड का Drupal यूआरएल इस तरह का होता है: http://<drupalBasePath>/<drupalBasePath>/apis/<drupalBasePath>/<drupalBasePath>. यूआरएल के फ़ॉर्म को कंट्रोल करने के लिए, नीचे दिया गया तरीका अपनाएं:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal एडमिन मेन्यू में कॉन्फ़िगरेशन > खोज और मेटाडेटा > यूआरएल के उपनाम > पैटर्न चुनें.
  3. सभी SmartDocs मेथड पाथ के पैटर्न में जाकर, यह बताएं कि पाथ कैसे जनरेट करना है.
  4. कॉन्फ़िगरेशन सेव करें चुनें.

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

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal एडमिन मेन्यू में कॉन्फ़िगरेशन > SmartDocs चुनें.
  3. SmartDocs मॉडल की कैश मेमोरी फिर से बनाएं पर क्लिक करें.

नोड को अनपब्लिश करना

पब्लिश किए गए नोड को कभी भी अनपब्लिश किया जा सकता है. किसी नोड को अनपब्लिश करने से, वह पोर्टल इस्तेमाल करने वालों को नहीं दिखता.

नोड को अनपब्लिश करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal के एडमिन मेन्यू में कॉन्टेंट > SmartDocs चुनें.
  3. जिस मॉडल को अनपब्लिश करना है उसके लिए, ऑपरेशंस सेक्शन में एपीआई में बदलाव चुनें.
  4. उस नोड के मॉडल में बदलाव चुनें जिसे आपको अनपब्लिश करना है.
  5. अनपब्लिश करने के लिए, संशोधन में नोड चुनें.
  6. अपडेट विकल्प ड्रॉपडाउन से, अनपब्लिश करें नोड चुनें.
  7. अपडेट करें पर क्लिक करें.

किसी मॉडल का संशोधन देखना

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

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

किसी मॉडल में हुए बदलाव को देखने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal के एडमिन मेन्यू में कॉन्टेंट > SmartDocs चुनें.
  3. आपको जिस मॉडल को अपडेट करना है उसके लिए, ऑपरेशन सेक्शन में एपीआई में बदलाव चुनें.
  4. वह मॉडल संशोधन चुनें जिसे आप देखना चाहते हैं.
  5. ऊपर बताए गए तरीके से नोड रेंडर और पब्लिश करें.

नोड में बदलाव करना

किसी नोड को रेंडर करने के बाद, आप Drupal एडिटर का इस्तेमाल करके उसमें बदलाव कर सकते हैं. उदाहरण के लिए, किसी एपीआई की एचटीटीपी कार्रवाई और जानकारी में बदलाव किया जा सकता है या एपीआई में नई क्वेरी या हेडर पैरामीटर जोड़ा जा सकता है. आपके पास WADL फ़ाइल या OpenAPI स्पेसिफ़िकेशन से बनाए गए नोड या मैन्युअल तरीके से बनाए गए नोड में बदलाव करने का विकल्प होता है.

आपके पास ओरिजनल WADL फ़ाइल या OpenAPI स्पेसिफ़िकेशन में बदलाव करने का विकल्प भी होता है. बदलाव करने के बाद, WADL फ़ाइल या OpenAPI स्पेसिफ़िकेशन को नए रिविज़न के तौर पर इंपोर्ट करें. इसके बाद, ऊपर बताए गए तरीके से अपने बदलावों को रेंडर करें और पब्लिश करें.

Drupal एडिटर का इस्तेमाल करके नोड में बदलाव करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. उस एपीआई दस्तावेज़ से जुड़े Drupal नोड को ब्राउज़ करें जिसमें आपको बदलाव करना है.
  3. Drupal एडिटर का इस्तेमाल करने के लिए, बदलाव करें चुनें.
  4. बदलाव करने के बाद, तरीका अपडेट करें चुनें.

इसके अलावा, SmartDocs मॉडल से नोड में बदलाव किया जा सकता है:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal के एडमिन मेन्यू में कॉन्टेंट > SmartDocs चुनें.
  3. आपको जिस मॉडल को अपडेट करना है उसके लिए, ऑपरेशन सेक्शन में एपीआई में बदलाव चुनें.
  4. वह मॉडल संशोधन चुनें जिसे आप प्रकाशित करना चाहते हैं.
  5. आपको जिस तरीके में बदलाव करना है उसके लिए, ऑपरेशन ड्रॉपडाउन में बदलाव के तरीके को चुनें.

नोड को मिटाने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal के एडमिन मेन्यू में कॉन्टेंट > SmartDocs चुनें.
  3. आपको जिस मॉडल को अपडेट करना है उसके लिए, ऑपरेशन सेक्शन में एपीआई में बदलाव चुनें.
  4. वह मॉडल संशोधन चुनें जिसे आप प्रकाशित करना चाहते हैं.
  5. तरीके के लिए, ऑपरेशन ड्रॉपडाउन में तरीका मिटाएं चुनें.
    चेतावनी: नोड को मिटाने से, मॉडल से एपीआई भी हट जाता है. अगर आपको एपीआई को सिर्फ़ अनपब्लिश करना है, ताकि उसे पोर्टल का इस्तेमाल करने वालों से छिपा दिया जाए, लेकिन उसे मॉडल से नहीं मिटाना है, तो ऊपर बताए गए तरीके से नोड को अनपब्लिश कर दें.

पोर्टल में पहले से एक रिपोर्ट होती है, जो SmartDocs मॉडल से रेंडर किए गए ऐसे किसी भी नोड के बारे में जानकारी दिखाती है जो अब मॉडल के किसी मान्य तरीके के बारे में नहीं बताता है. रिपोर्ट को ऐक्सेस करने के लिए, Drupal मेन्यू में रिपोर्ट चुनें. इसके बाद, SmartDocs नोड स्टेटस नाम की रिपोर्ट चुनें.

मॉडल को एक्सपोर्ट और इंपोर्ट करना

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

मॉडल इंपोर्ट करने से, मॉडल का एक नया रिविज़न बन जाता है. SmartDocs, इस मॉडल में मौजूदा एपीआई का मिलान, इंपोर्ट किए गए एपीआई के साथ करने की कोशिश करता है. अगर SmartDocs को किसी मैच का पता चलता है, तो इंपोर्ट, मौजूदा एपीआई से जुड़े Drupal नोड को अपडेट कर देता है. अगर SmartDocs को कोई मैच नहीं मिलता, तो इंपोर्ट एपीआई के लिए एक नया Drupal नोड बनाता है.

उदाहरण के लिए, आपके पास ऐसा POST API है जो 91 के आईडी वाले Drupal नोड से जुड़ा होता है. इसके बाद, कोई मॉडल इंपोर्ट करें. इसके बाद, SmartDocs यह पता लगाता है कि इंपोर्ट किए गए मॉडल में मौजूद POST API का डेटा, मौजूदा POST API से मिलता-जुलता है या नहीं. इसके बाद, POST API में कोई अपडेट होने पर, Drupal नोड 91 को अपडेट करें. अगर SmartDocs को कोई मैच नहीं मिलता है, तो वह नए आईडी के साथ एक नया Drupal नोड बनाता है.

Drupal, एपीआई की इन विशेषताओं का इस्तेमाल करके मिलान करता है:

  • internalName: आंतरिक मॉडल नाम.
  • httpMethod: एपीआई का एचटीटीपी तरीका, जैसे: GET, PUT, POST या DELETE.
  • resourcePath: संसाधन पाथ.
  • query params: एपीआई में इस्तेमाल किया जाने वाला कोई भी क्वेरी पैरामीटर.

अगर इंपोर्ट किए गए किसी एपीआई की सभी चारों विशेषताएं, मॉडल में मौजूद एपीआई से मेल खाती हैं, तो SmartDocs की मदद से मौजूदा Drupal नोड को अपडेट किया जा सकता है.

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

  • revisionNumber
  • createdTime
  • modifiedTime
  • apiRevisionId
  • resourceId

मॉडल एक्सपोर्ट करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal के एडमिन मेन्यू में कॉन्टेंट > SmartDocs चुनें.
  3. आपको जिस मॉडल को एक्सपोर्ट करना है उसके लिए ऑपरेशन में जाकर, एक्सपोर्ट करें चुनें.
  4. एक्सपोर्ट फ़ाइल टाइप को SmartDocs JSON के तौर पर चुनें.
  5. एक्सपोर्ट करें पर क्लिक करें.
  6. आपको इस फ़ाइल को डिस्क पर सेव करने या किसी एडिटर में खोलने के लिए कहा जाएगा.

मॉडल इंपोर्ट करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal के एडमिन मेन्यू में कॉन्टेंट > SmartDocs चुनें.
  3. आपको जिस मॉडल को इंपोर्ट करना है उसके लिए, ऑपरेशन में जाकर इंपोर्ट करें चुनें.
  4. फ़ॉर्मैट चुनें ड्रॉपडाउन में, SmartDocs JSON चुनें.
  5. अपलोड टाइप में, फ़ाइल या यूआरएल चुनें:
    1. अगर आपने फ़ाइल चुनी, तो JSON फ़ाइल ब्राउज़ करें.
    2. अगर आपने यूआरएल चुना है, तो SmartDocs की JSON फ़ाइल का यूआरएल बताएं.
  6. इसे मॉडल में इंपोर्ट करने के लिए, इंपोर्ट करें पर क्लिक करें.
  7. आपको मॉडल के जानकारी वाले पेज पर रीडायरेक्ट किया जाता है. यहां अब मॉडल को रेंडर किया जा सकता है. ध्यान दें कि इंपोर्ट करने से, मॉडल का एक नया बदलाव बनता है.
  8. नोड को रेंडर करना और पब्लिश करना.

SmartDocs के टेंप्लेट में बदलाव करना

SmartDocs का टेंप्लेट तय करता है कि स्क्रीन पर Drupal नोड किस तरह दिखेंगे. SmartDocs का हर मॉडल एक ही डिफ़ॉल्ट टेंप्लेट का इस्तेमाल कर सकता है. इसके अलावा, आपके पास किसी एक मॉडल के लिए इस्तेमाल किए जाने वाले टेंप्लेट को मैन्युअल तरीके से अपनी पसंद के मुताबिक बनाने का विकल्प भी होता है.

SmartDocs के टेंप्लेट में ऐसी टेंप्लेट फ़ाइल शामिल होती है जिसे हैंडलबार .hbr फ़ाइल, सीएसएस फ़ाइलों, और JavaScript फ़ाइलों के तौर पर कोड किया जाता है. हैंडलबार की मदद से, ज़्यादातर कॉन्टेंट, &123;&123;body}} जैसे एम्बेड किए गए हैंडलबार एक्सप्रेशन का इस्तेमाल करके, वैरिएबल पर आधारित होता है. मौजूदा हैंडलबार एक्सप्रेशन की सूची, फ़ाइल के सबसे ऊपर एक टिप्पणी में दी जाती है. अपने टेंप्लेट को पसंद के मुताबिक बनाने के लिए, हैंडलबार का इस्तेमाल करने के बारे में जानकारी के लिए, http://handlebarsjs.com पर जाएं.

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

कस्टम SmartDocs की टेंप्लेट फ़ाइल अपलोड करना

आपके पास कस्टम SmartDocs टेंप्लेट फ़ाइल को हैंडलबार .hbr फ़ाइल के तौर पर अपलोड करने का विकल्प है. इससे नए मॉडल बनाते समय या किसी मौजूदा मॉडल में नए एपीआई इंपोर्ट करते समय, डिफ़ॉल्ट टेंप्लेट के तौर पर इस्तेमाल किया जा सकता है.

अपनी कस्टम SmartDocs टेंप्लेट फ़ाइल बनाते समय, शुरुआती पॉइंट के तौर पर अगर आपको डिफ़ॉल्ट SmartDocs टेंप्लेट फ़ाइल का इस्तेमाल करना है, तो इसकी कॉपी डाउनलोड की जा सकती है: profiles/apigee/modules/custom/devconnect/smartdocs/templates/smartdocs.hbr

कस्टम SmartDocs की टेंप्लेट फ़ाइल अपलोड करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal एडमिन मेन्यू में कॉन्फ़िगरेशन > SmartDocs चुनें.
  3. पेज के बेहतर सेटिंग वाले हिस्से को बड़ा करें.
  4. 'पसंद के मुताबिक तरीके का टेंप्लेट अपलोड करें' सेक्शन में, फ़ाइल चुनें पर क्लिक करें. इसके बाद, हैंडलबार .hbr फ़ाइल पर जाएं.
  5. अपलोड करें पर क्लिक करें.
  6. कॉन्फ़िगरेशन सेव करें पर क्लिक करें.

SmartDocs की डिफ़ॉल्ट टेंप्लेट फ़ाइल को वापस लाया जा रहा है

SmartDocs की डिफ़ॉल्ट टेंप्लेट फ़ाइल को वापस लाया जा सकता है. वापस लाने के बाद, नए मॉडल बनाते समय या किसी मौजूदा मॉडल में नए एपीआई इंपोर्ट करते समय, डिफ़ॉल्ट SmartDocs टेंप्लेट फ़ाइल का इस्तेमाल किया जाएगा.

SmartDocs की डिफ़ॉल्ट टेंप्लेट फ़ाइल को पहले जैसा करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal एडमिन मेन्यू में कॉन्फ़िगरेशन > SmartDocs चुनें.
  3. पेज के बेहतर सेटिंग वाले हिस्से को बड़ा करें.
  4. 'पसंद के मुताबिक बनाया गया तरीका टेंप्लेट अपलोड करें' में जाकर, कस्टम SmartDocs टेंप्लेट फ़ाइल के बगल में हटाएं पर क्लिक करें.
  5. कॉन्फ़िगरेशन सेव करें पर क्लिक करें.

किसी एक मॉडल के लिए SmartDocs के टेंप्लेट में बदलाव करना

किसी मॉडल के लिए इस्तेमाल किए गए टेंप्लेट में बदलाव किया जा सकता है.

हर एक मॉडल के टेंप्लेट में बदलाव करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal एडमिन मेन्यू में कॉन्टेंट > SmartDocs को चुनें.
  3. आपको जिस मॉडल में बदलाव करना है उसके लिए, ऑपरेशन में जाकर सेटिंग चुनें.
  4. 'तरीका टेंप्लेट' एरिया में, ज़रूरत के हिसाब से टेंप्लेट में बदलाव करें.
  5. टेंप्लेट सेव करें पर क्लिक करें.
  6. किसी Drupal नोड को ब्राउज़ करें. आपको पेज पर अपने टेंप्लेट में किए गए बदलाव दिखेंगे.

SmartDocs की पुष्टि करने के तरीके को कॉन्फ़िगर करना

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

सुरक्षित एपीआई के लिए, SmartDocs की मदद से पुष्टि करने के ये तरीके यहां बताए गए हैं:

  • सामान्य पुष्टि करना - उपयोगकर्ता नाम और पासवर्ड के पेयर के तौर पर, पुष्टि करने के बुनियादी क्रेडेंशियल पास करें. अगर आपने यह तय नहीं किया है कि OAuth को क्रेडेंशियल टाइप के तौर पर इस्तेमाल किया जाए, तो एपीआई डिफ़ॉल्ट रूप से, बुनियादी पुष्टि का इस्तेमाल करता है.
  • OAuth 2.0 - सेवा देने वाली तीसरे पक्ष की कंपनी, उपयोगकर्ता के क्रेडेंशियल की पुष्टि करती है और यह पक्का करती है कि उपयोगकर्ता के पास एपीआई को इस्तेमाल करने की अनुमति हो. इसके बाद, वह ऐक्सेस टोकन जारी करता है. जब किसी सुरक्षित एपीआई को SmartDocs की अनुरोध की जाती है, तो SmartDocs की मदद से अनुरोध तैयार किया जाता है और उसे सेवा देने वाली कंपनी को भेजा जाता है. इसके बाद, सेवा देने वाली कंपनी टोकन की पुष्टि करती है और यह पक्का करती है कि उसकी समयसीमा खत्म न हुई हो.
  • पसंद के मुताबिक टोकन - हर अनुरोध के लिए, हेडर या क्वेरी पैरामीटर के तौर पर टोकन वैल्यू पास करें.

पुष्टि करने के हर तरीके के लिए, आपको एक सुरक्षा स्कीम बनानी होती है. यह स्कीम, पुष्टि करने की विशेषताओं के बारे में बताती है. उदाहरण के लिए, कस्टम टोकन की पुष्टि करने के लिए, सुरक्षा स्कीम तय करती है कि टोकन कैसे पास किया जाता है (हेडर, क्वेरी पैरामीटर, बॉडी पैरामीटर) और टोकन का नाम.

सुरक्षा स्कीम, मॉडल के किसी खास बदलाव से जुड़ी होती है. इसलिए, अगर किसी मॉडल का नया वर्शन बनाया जाता है, तो आपको उस रिविज़न के लिए सुरक्षा से जुड़ी स्कीम को फिर से तय करना होगा

WADL फ़ाइल में, आपको यह बताना होता है कि <apigee:authentication> Apigee टैग का इस्तेमाल करके, एपीआई को पुष्टि करने की ज़रूरत है या नहीं, जैसा कि यहां दिखाया गया है:

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

अगर एपीआई खुला है, तो ज़रूरी एट्रिब्यूट को false पर सेट करें.

ध्यान दें कि WADL फ़ाइल में पुष्टि करने का टाइप तय नहीं किया जा सकता. इसके लिए, आपको Drupal में नोड में बदलाव करना होगा. WADL फ़ाइलों के बारे में ज़्यादा जानने के लिए, WADL रेफ़रंस देखें.

Drupal के एपीआई पेज पर SmartDocs की मदद से, नीचे दिया गया बटन जोड़ा जाता है. इससे, उपयोगकर्ताओं को पुष्टि करने के बुनियादी क्रेडेंशियल तय करने में मदद मिलती है:

अगर पुष्टि के टाइप को OAuth पर सेट करने के लिए, नोड में बदलाव किया जाता है, तो SmartDocs की मदद से पेज पर यह बटन जोड़ा जाता है:

कस्टम टोकन के लिए, SmartDocs यह सुविधा उपलब्ध कराता है:

पुष्टि करने की बुनियादी प्रक्रिया को कॉन्फ़िगर किया जा रहा है

एपीआई के साथ बुनियादी तौर पर पुष्टि करने की सुविधा इस्तेमाल करने पर, आपको WADL फ़ाइल में सिर्फ़ <apigee:authentication> टैग के बारे में जानकारी देनी होगी जिसका इस्तेमाल मॉडल बनाने के लिए किया जाता है.

WADL फ़ाइल के अलावा, किसी अन्य सोर्स से बनाए गए तरीकों की पुष्टि करने की बुनियादी सुविधा लागू करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal एडमिन मेन्यू में जाकर कॉन्टेंट > SmartDocs चुनें.
  3. अपनी पसंद के मॉडल के लिए, 'ऑपरेशन' में जाकर एपीआई में बदलाव चुनें.
  4. आपको जिस मॉडल में बदलाव करना है उसके लिए ऑपरेशन में जाकर, सुरक्षा सेटिंग चुनें.
  5. सुरक्षा स्कीम जोड़ें चुनें.
  6. सिक्योरिटी स्कीम का नाम बताएं.
  7. टाइप के तौर पर बेसिक को चुनें.
  8. सबमिट करें चुनें.
  9. मॉडल में हर तरीके के लिए, उसकी सुरक्षा स्कीम को अपनी बेसिक स्कीम पर सेट करने के तरीके में बदलाव करें.
    1. Drupal एडमिन मेन्यू में जाकर कॉन्टेंट > SmartDocs चुनें.
    2. अपनी पसंद के मॉडल के लिए, 'ऑपरेशन' में जाकर एपीआई में बदलाव चुनें.
    3. आपको जिस मॉडल में बदलाव करना है उसके लिए ऑपरेशन में जाकर, बदलाव की जानकारी चुनें.
    4. उस एपीआई के लिए बदलाव का तरीका चुनें जिसमें आपको बदलाव करना है.
    5. एपीआई के लिए सुरक्षा स्कीम चुनें.
    6. एपीआई सेव करें.

OAuth 2.0 की पुष्टि करने की प्रक्रिया को कॉन्फ़िगर करना

आपके पास SmartDocs में पुष्टि करने के डिफ़ॉल्ट के बजाय, OAuth 2.0 का इस्तेमाल करने के लिए, कोई मॉडल कॉन्फ़िगर करने का विकल्प होता है. OAuth को दो जगहों पर कॉन्फ़िगर किया जा सकता है:

  1. सुरक्षा सेटिंग में जाकर, मॉडल के हर बदलाव के लिए एक सिक्योरिटी स्कीम बनाएं.
  2. मॉडल के सभी बदलावों के लिए क्लाइंट आईडी और क्लाइंट सीक्रेट तय करें. इसके लिए, मॉडल की सेटिंग में जाएं.

OAuth को चालू करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal एडमिन मेन्यू में जाकर कॉन्टेंट > SmartDocs चुनें.
  3. अपनी पसंद के मॉडल के लिए, 'ऑपरेशन' में जाकर एपीआई में बदलाव चुनें.
  4. आपको जिस मॉडल में बदलाव करना है उसके लिए ऑपरेशन में जाकर, सुरक्षा सेटिंग चुनें.
  5. सुरक्षा स्कीम जोड़ें चुनें.
  6. सिक्योरिटी स्कीम का नाम बताएं.
  7. टाइप के तौर पर OAuth 2.0 चुनें.
  8. अनुदान प्रकार सेट करें.
  9. ऑथराइज़ेशन यूआरएल फ़ील्ड में वैल्यू डालें. ऐक्सेस टोकन पाने के लिए, अनुमति देने वाले यूआरएल का इस्तेमाल किया जाता है.
  10. ऑथराइज़ेशन वर्ब को GET या POST के तौर पर सेट करें.
  11. ऐक्सेस टोकन का यूआरएल डालें. ऐक्सेस टोकन यूआरएल वह यूआरएल होता है जिसका इस्तेमाल अनुरोध टोकन को ऐक्सेस टोकन में बदलने के लिए किया जाता है.
  12. ऐक्सेस टोकन पैरामीटर का नाम डालें.
  13. टोकन को पास करने का तरीका बताने के लिए, In का इस्तेमाल करें: हेडर, क्वेरी या मुख्य टेक्स्ट.
  14. OAuth का स्कोप सेट करें.
  15. सबमिट करें चुनें.
  16. Drupal एडमिन मेन्यू में जाकर कॉन्टेंट > SmartDocs चुनें.
  17. मॉडल के लिए, ऑपरेशन ड्रॉप-डाउन में सेटिंग चुनें.
  18. क्लाइंट आईडी और क्लाइंट सीक्रेट में वैल्यू डालें.
  19. टेंप्लेट की पुष्टि करने की सेटिंग सेव करें चुनें.
  20. मॉडल में हर तरीके के लिए, अपने OAuth सिक्योरिटी स्कीम में सुरक्षा स्कीम सेट करने के तरीके में बदलाव करें.
    1. Drupal एडमिन मेन्यू में जाकर कॉन्टेंट > SmartDocs चुनें.
    2. अपनी पसंद के मॉडल के लिए, 'ऑपरेशन' में जाकर एपीआई में बदलाव चुनें.
    3. आपको जिस मॉडल में बदलाव करना है उसके लिए ऑपरेशन में जाकर, बदलाव की जानकारी चुनें.
    4. उस एपीआई के लिए बदलाव का तरीका चुनें जिसमें आपको बदलाव करना है.
    5. एपीआई के लिए सुरक्षा स्कीम चुनें.
    6. एपीआई सेव करें.

कस्टम टोकन की पुष्टि करने की सुविधा को कॉन्फ़िगर करना

कस्टम टोकन की पुष्टि करने की सुविधा का इस्तेमाल करने के लिए, किसी मॉडल को कॉन्फ़िगर किया जा सकता है.

कस्टम टोकन चालू करने के लिए:

  1. अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
  2. Drupal एडमिन मेन्यू में जाकर कॉन्टेंट > SmartDocs चुनें.
  3. अपनी पसंद के मॉडल के लिए, 'ऑपरेशन' में जाकर एपीआई में बदलाव चुनें.
  4. आपको जिस मॉडल में बदलाव करना है उसके लिए ऑपरेशन में जाकर, सुरक्षा सेटिंग चुनें.
  5. सुरक्षा स्कीम जोड़ें चुनें.
  6. सिक्योरिटी स्कीम का नाम बताएं.
  7. टाइप के तौर पर Apikey चुनें.
  8. उस परम नाम को सेट करें जिसमें टोकन मौजूद है.
  9. टोकन को पास करने का तरीका बताने के लिए, In का इस्तेमाल करें: Header, Query या Body.
  10. सबमिट करें चुनें.
  11. मॉडल में हर तरीके के लिए, अपनी टोकन स्कीम के लिए सुरक्षा स्कीम सेट करने के तरीके में बदलाव करें.
    1. Drupal एडमिन मेन्यू में जाकर कॉन्टेंट > SmartDocs चुनें.
    2. अपनी पसंद के मॉडल के लिए, 'ऑपरेशन' में जाकर एपीआई में बदलाव चुनें.
    3. आपको जिस मॉडल में बदलाव करना है उसके लिए ऑपरेशन में जाकर, बदलाव की जानकारी चुनें.
    4. उस एपीआई के लिए बदलाव का तरीका चुनें जिसमें आपको बदलाव करना है.
    5. एपीआई के लिए सुरक्षा स्कीम चुनें.
    6. एपीआई सेव करें.

मॉडल मिटाना

जब Drupal के ऑपरेशन फ़ील्ड में जाकर किसी मॉडल (कॉन्टेंट > SmartDocs, मिटाएं) को मिटाया जाता है, तो वह मॉडल आपके Edge संगठन से मिट जाता है. इसका मतलब है कि अगर दूसरे पोर्टल मॉडल का रेफ़रंस दे रहे हैं, तो यह मॉडल अब उपलब्ध नहीं होगा. ज़्यादा जानकारी के लिए, SmartDoc मॉडल और टेंप्लेट के बारे में जानकारी देखें.