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

आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इस पेज पर जाएं Apigee X दस्तावेज़. जानकारी

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

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

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

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

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

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

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

पोर्टल पर दो एपीआई दस्तावेज़ दर्ज किए गए हैं: Hello World और Pet Store का उदाहरण.

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, मॉडल का इस्तेमाल करके आपके एपीआई को दिखाता है. इस मॉडल में एपीआई के बारे में जानकारी. यह पोर्टल, मॉडल से आपके एपीआई के बारे में जानकारी इकट्ठा करता है पोर्टल पर दस्तावेज़ के पेजों को 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 फ़ाइल में बदलाव करके, Drupal नोड में बदलाव करें या OpenAPI की खास बातें. WADL फ़ाइल या OpenAPI स्पेसिफ़िकेशन में, बदलाव करने के बाद, इंपोर्ट करें उसे मॉडल में वापस एक नए संशोधन के रूप में शामिल करें, फिर अपने बदलावों को रेंडर और प्रकाशित करें.
7. TLS चालू करें. क्योंकि SmartDocs, आपके अपने एपीआई से अनुरोध करने के लिए बैकएंड पर, अपने पोर्टल पर TLS की सुविधा चालू करनी चाहिए, ताकि सुनिश्चित करें कि वे क्रेडेंशियल सुरक्षित हैं. पोर्टल प्रोडक्शन और टेस्ट एनवायरमेंट में, Apigee, https:// अनुरोध करने के लिए ज़रूरी TLS सर्टिफ़िकेट उपलब्ध कराता है. हालांकि, आगे बढ़ने से पहले अगर आपको अपने पोर्टल पर जाना है, तो आपको अपना खुद का TLS सर्टिफ़िकेट हासिल करना होगा और TLS की सुविधा चालू करनी होगी. ज़्यादा जानकारी के लिए, यह देखें Google Ads पर 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 ने SmartDocs को कस्टम Drupal मॉड्यूल के तौर पर लागू किया. नीचे दी गई प्रक्रिया का इस्तेमाल करके SmartDocs मॉड्यूल को कॉन्फ़िगर करें.

SmartDocs मॉड्यूल को कॉन्फ़िगर करने के लिए:

1. अपने पोर्टल में ऐसे उपयोगकर्ता के तौर पर लॉग इन करें जिसके पास एडमिन या कॉन्टेंट बनाने के अधिकार हों.
2. Drupal के एडमिन मेन्यू में जाकर, मॉड्यूल चुनें. सभी की सूची इंस्टॉल किए गए Drupal मॉड्यूल दिखते हैं.
3. SmartDocs मॉड्यूल चालू करें.
4. कॉन्फ़िगरेशन को सेव करें.
5. Drupal के एडमिन मेन्यू में जाकर, मॉड्यूल चुनें.
6. SmartDocs -> चुनें अनुमतियां और पक्का करें कि "एडमिन के तौर पर काम करें SmartDocs मॉड्यूल के लिए टास्क" "एडमिन" के लिए भूमिका सक्षम है.
7. कॉन्फ़िगरेशन > चुनें Drupal के एडमिनिस्ट्रेशन में डेवलपर पोर्टल मेन्यू.
8. कनेक्शन का टाइम आउट और अनुरोध का टाइम आउट को 16 पर सेट करें सेकंड.
9. कॉन्फ़िगरेशन को सेव करें.
10. यूआरएल सेटिंग कॉन्फ़िगर करें:
    1. कॉन्फ़िगरेशन > चुनें खोज और मेटाडेटा > यूआरएल के अन्य नाम > सेटिंग पर क्लिक करें.
    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: एपीआई का एचटीटीपी तरीका, जैसे कि get, put, post, या मिटाएं.
• resourcePath: संसाधन का पाथ.

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

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

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

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

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

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

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

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

किसी मॉडल में एपीआई जोड़ने के लिए:

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

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

WADL इंपोर्ट करना

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

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

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

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

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

OpenAPI की खास जानकारी इंपोर्ट करने के लिए:

1. अपने पोर्टल में ऐसे उपयोगकर्ता के तौर पर लॉग इन करें जिसके पास एडमिन या कॉन्टेंट बनाने के अधिकार हों.
2. चुनें कॉन्टेंट > SmartDocs Drupal का एडमिन मेन्यू.
3. वह मॉडल चुनें जिसे आपको अपडेट करना है.
4. ऑपरेशन में जाकर, इंपोर्ट करें चुनें.
5. Swager JSON या Swagger YAML को चुनें. इसके बाद, SmartDocs इंपोर्ट पेज पर फ़ॉर्मैट चुनें ड्रॉपडाउन.
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. हर संसाधन के लिए एक या उससे ज़्यादा तरीके तय करें. तरीका HTTP क्रिया के बारे में बताता है जिसे किसी संसाधन पर शुरू होता है. उदाहरण के लिए, "/login" के लिए POST का इस्तेमाल किया जा सकता है और लॉग आउट करने के लिए मिटाएं. यह संसाधन अन्य HTTP क्रियाओं, जैसे PUT या GET का समर्थन नहीं करता. इसलिए, रिसॉर्स के लिए दो तरीके तय करें, पहला POST के लिए और दूसरा DELETE के लिए.
   अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
   अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है यह तरीका, अपने पैरंट संसाधन से संसाधन का यूआरएल इस्तेमाल करता है. इसलिए, सभी विधियों यूआरएल को SmartDocs में एक संसाधन के तहत तय किया जाता है.

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

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

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

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

किसी मॉडल का एक नया संशोधन बनाने के लिए:

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

संसाधन के बारे में जानकारी

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

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

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

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

इसके अलावा, किसी तरीके में पैरामीटर भी तय किए जा सकते हैं. उदाहरण के लिए, एक POST तरीका वे क्वेरी पैरामीटर जो DELETE तरीके का इस्तेमाल नहीं करते. इसलिए, यदि आप चाहें, तो किसी विशेषता के लिए खास तौर पर तब बनाया जा सकता है, जब आप

नीचे दी गई इमेज Apigee, डेवलपर ऐप्लिकेशन को मंज़ूरी देना या रद्द करना एपीआई को हर तरह के पैरामीटर के साथ हाइलाइट करना:

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

टाइप	JSON ऑब्जेक्ट	नोट
टेंप्लेट	{ "dataType": "स्ट्रिंग", "defaultValue": "", "description": "संगठन का नाम.", अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है "name": "org_name", "ज़रूरी": सही, "type": "TEMPLATE" }	टेंप्लेट पैरामीटर हमेशा ज़रूरी होते हैं, इसलिए ज़रूरी को true पर सेट करें और वैल्यू को छोड़ दें defaultValue. description की वैल्यू जब उपयोगकर्ता SmartDocs पेज में यूआरएल पर कर्सर घुमाता है, तो पॉप-अप दिखता है.
क्वेरी	{ "dataType": "स्ट्रिंग", "defaultValue": "", "description": "जगह.", अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है "name": "w", "ज़रूरी": सही, "type": "QUERY" }	ज़रूरी क्वेरी पैरामीटर अब भी defaultValue तय कर सकते हैं, लेकिन अक्सर ऐसा नहीं होता. वैकल्पिक क्वेरी पैरामीटर के लिए, ज़रूरी को false पर सेट करें और defaultValue.
हेडर	{ "dataType": "स्ट्रिंग", "defaultValue": "application/json", "description": "<code>application/json</code> के बारे में बताएं.", "name": "कॉन्टेंट किस तरह का है", "ज़रूरी": सही, "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 एपीआई पेज में, उपयोगकर्ता को यूआरएल में org_name और developer_email वाला हिस्सा डालने के लिए तो वे कोई अनुरोध सबमिट कर सकते हैं.

तरीका तय करना

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

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

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

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

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

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

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

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

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

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

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

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

नोड पब्लिश किए जा रहे हैं

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

इसके अलावा, आपके पास SmartDocs मॉडल से नोड में बदलाव करने का विकल्प भी होता है:

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

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

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

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

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

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

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

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

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

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

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

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

• revisionNumber
• createdTime
• modifiedTime
• apiRevisionId
• resourceId

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

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

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

1. अपने पोर्टल में ऐसे उपयोगकर्ता के तौर पर लॉग इन करें जिसके पास एडमिन या कॉन्टेंट बनाने के अधिकार हों.
2. चुनें कॉन्टेंट > अब SmartDocs Drupal का एडमिन मेन्यू.
3. आप जिस मॉडल को इंपोर्ट करना चाहते हैं उसके नीचे इंपोर्ट करें को चुनें ऑपरेशन.
4. फ़ॉर्मैट चुनें ड्रॉपडाउन में SmartDocs JSON चुनें.
5. इसमें File या URL चुनें अपलोड टाइप:
   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 टेंप्लेट फ़ाइल को हैंडलबार .hbr फ़ाइल के तौर पर अपलोड करने का विकल्प होता है. डिफ़ॉल्ट टेंप्लेट का इस्तेमाल करें.

अगर आपको दस्तावेज़ बनाते समय डिफ़ॉल्ट रूप से 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 का एडमिन मेन्यू.
3. जिस मॉडल में आप बदलाव करना चाहते हैं उसके लिए, सेटिंग को ऑपरेशन.
4. तरीके टेंप्लेट एरिया में, टेंप्लेट में ज़रूरत के हिसाब से बदलाव करें.
5. टेंप्लेट सेव करें पर क्लिक करें.
6. किसी Drupal नोड को ब्राउज़ करें. आपको पेज पर अपने टेंप्लेट में किए गए बदलाव दिखेंगे.

मैन्युअल तरीके से की गई बिडिंग की रणनीति को कॉन्फ़िगर करना SmartDocs पुष्टि करने का टाइप

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

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

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

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

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

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

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

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

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

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

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

कस्टम टोकन के लिए, SmartDocs यह जानकारी जोड़ता है:

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

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

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

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

कॉन्फ़िगर किया जा रहा है OAuth 2.0 की पुष्टि करना

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

1. सुरक्षा के अंतर्गत किसी मॉडल के प्रत्येक संशोधन के लिए एक सुरक्षा स्कीम बनाएं बदलाव के लिए सेटिंग.
2. के अंतर्गत मॉडल के सभी संशोधनों के लिए Client-ID और क्लाइंट सीक्रेट तय करें मॉडल के लिए सेटिंग.

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

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

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

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

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

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

मॉडल को मिटाना

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