यह लेख सबसे छोटे के लिए लेख स्वचालन की श्रृंखला के दौरान छोटे नोटों में से एक है।
चूंकि IPAM सिस्टम के साथ बातचीत करने का मुख्य तरीका RESTful API है, इसलिए मैंने इसके बारे में अलग से बात करने का फैसला किया।

मैं आधुनिक दुनिया के वास्तुकारों की प्रशंसा करता हूं - हमारे पास मानकीकृत इंटरफेस हैं। हां, उनमें से कई हैं - यह एक ऋण है, लेकिन वे हैं - यह एक प्लस है।

इन इंटरफेस ने एपीआई - एप्लिकेशन प्रोग्रामिंग इंटरफेस नाम प्राप्त किया है।

इन इंटरफेस में से एक RESTful API है, जिसका उपयोग नेटबॉक्स के साथ काम करने के लिए किया जाता है।

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

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

इस प्रकार, एक बार एक इंटरफेस लिखने के बाद, निर्माता हमेशा अपने आप को प्रत्येक नए ग्राहक के साथ सहमत होने की आवश्यकता से मुक्त करता है कि इसे कैसे कनेक्ट किया जाए (हालांकि यह थोड़ा चालाक है)।

सामग्री

REST, RESTful, API
HTTP संदेश संरचना
- स्टार्ट लाइन
- सुर्खियों में
- HTTP संदेश का मुख्य भाग
तरीकों
- HTTP जीईटी
- HTTP POST
- HTTP PUT
- HTTP PATCH
- HTTP DELETE
रेस्टफुल एपीआई के साथ काम करने के तरीके
- कर्ल
- पत्रवाहक
- पायथन + अनुरोध
- Pynebtbox एसडीके
- अकड़
आरईएसटी और विकल्प की आलोचना
उपयोगी लिंक

REST, RESTful, API

नीचे मैं बहुत सरल विवरण दूंगा कि REST क्या है।

शुरुआत करने के लिए, RESTful API वास्तव में REST- आधारित इंटरैक्शन इंटरफ़ेस है , जबकि REST ( REpretational State Transfer ) स्वयं WEB सेवाओं को बनाने के लिए उपयोग किए जाने वाले प्रतिबंधों का एक समूह है।

रॉय फील्डिंग के शोध प्रबंध, वास्तुकला शैलियाँ और नेटवर्क-आधारित सॉफ़्टवेयर आर्किटेक्चर के डिज़ाइन के अध्याय 5 में वास्तव में क्या सीमाएं पाई जा सकती हैं, इसके बारे में पढ़ना संभव है। मुझे आप उनमें से केवल तीन सबसे महत्वपूर्ण (मेरे दृष्टिकोण से) दें:

REST आर्किटेक्चर क्लाइंट-सर्वर इंटरैक्शन मॉडल का उपयोग करता है।
प्रत्येक REST अनुरोध में इसके निष्पादन के लिए आवश्यक सभी जानकारी होती है। यही है, सर्वर को पिछले क्लाइंट अनुरोधों के बारे में कुछ भी याद नहीं रखना चाहिए, जो कि जैसा कि आप जानते हैं, स्टेटलेस शब्द की विशेषता है - जानकारी संग्रहीत न करें।
एकीकृत इंटरफ़ेस। एप्लिकेशन का कार्यान्वयन उस सेवा से अलग है जो इसे प्रदान करता है। यही है, उपयोगकर्ता जानता है कि यह क्या करता है और इसके साथ कैसे बातचीत करनी है, लेकिन यह कैसे होता है इससे कोई फर्क नहीं पड़ता। जब आप एप्लिकेशन बदलते हैं, तो इंटरफ़ेस समान रहता है, और क्लाइंट को समायोजित करने की आवश्यकता नहीं होती है।

WEB सेवाएँ जो REST के सभी सिद्धांतों को संतुष्ट करती हैं, RESTful WEB सेवाएँ कहलाती हैं।

और RESTful WEB सेवाएं प्रदान करने वाले API को RESTful API कहा जाता है।

REST एक प्रोटोकॉल नहीं है, बल्कि तथाकथित वास्तुकला शैली (एक) है। रॉय फील्डिंग द्वारा HTTP के साथ विकसित, REST का इरादा HTTP 1.1 को परिवहन के रूप में उपयोग करना था।

गंतव्य पता (या दूसरे शब्दों में - एक ऑब्जेक्ट, या किसी अन्य तरीके से - एक समापन बिंदु) - यह हमारा सामान्य यूआरआई है ।

प्रेषित डेटा का प्रारूप XML या JSON है ।

लिंकमेप पर लेखों की इस श्रृंखला के लिए, एक रीड-ओनली परिनियोजन (आपके लिए, प्रिय पाठकों के लिए) तैनात किया गया है। नेटबॉक्स इंस्टॉलेशन: netbox.linkmeup.ru : 45127।

पढ़ने के अधिकार की आवश्यकता नहीं है, लेकिन यदि आप टोकन के साथ पढ़ने की कोशिश करना चाहते हैं, तो आप इसका उपयोग कर सकते हैं: टोकन एपीआई: 90a22967d0bc4bdcd8ca47ec490bbf0b0cb2dc8 ।

चलो मज़े के लिए एक अनुरोध करें:

curl -X GET -H "Authorization: TOKEN 90a22967d0bc4bdcd8ca47ec490bbf0b0cb2d9c8" \ -H "Accept: application/json; indent=4" \ http://netbox.linkmeup.ru:45127/api/dcim/devices/1/

यही है, कर्ल उपयोगिता के साथ, हम netbox.linkmeup.ru पर एक GET ऑब्जेक्ट बनाते हैं : 45127 / api / dcim / डिवाइस / 1 / JSON प्रतिक्रिया और 4 रिक्त स्थान के एक इंडेंट के साथ।

या थोड़ा और अकादमिक रूप से: टाइप किए गए डिवाइस ऑब्जेक्ट को प्राप्त करें, जो DCIM ऑब्जेक्ट का एक पैरामीटर है।

आप इस अनुरोध को भी पूरा कर सकते हैं - बस इसे अपने टर्मिनल पर कॉपी करें।

जिस URL का हम अनुरोध कर रहे हैं, उसे समापन बिंदु कहा जाता है। एक मायने में, यह अंतिम वस्तु है जिसके साथ हम बातचीत करेंगे।
उदाहरण के लिए, नेटबॉक्स के मामले में, सभी समापन बिंदुओं की एक सूची यहां प्राप्त की जा सकती है ।

और URL के अंत में / साइन पर ध्यान दें - यह आवश्यक है ।

यहाँ हमें जवाब में क्या मिला है:

 { "id": 1, "name": "mlg-host-0", "display_name": "mlg-host-0", "device_type": { "id": 4, "url": "http://netbox.linkmeup.ru/api/dcim/device-types/4/", "manufacturer": { "id": 4, "url": "http://netbox.linkmeup.ru/api/dcim/manufacturers/4/", "name": "Hypermacro", "slug": "hypermacro" }, "model": "Server", "slug": "server", "display_name": "Hypermacro Server" }, "device_role": { "id": 1, "url": "http://netbox.linkmeup.ru/api/dcim/device-roles/1/", "name": "Server", "slug": "server" }, "tenant": null, "platform": null, "serial": "", "asset_tag": null, "site": { "id": 6, "url": "http://netbox.linkmeup.ru/api/dcim/sites/6/", "name": "", "slug": "mlg" }, "rack": { "id": 1, "url": "http://netbox.linkmeup.ru/api/dcim/racks/1/", "name": "A", "display_name": "A" }, "position": 41, "face": { "value": "front", "label": "Front", "id": 0 }, "parent_device": null, "status": { "value": "active", "label": "Active", "id": 1 }, "primary_ip": null, "primary_ip4": null, "primary_ip6": null, "cluster": null, "virtual_chassis": null, "vc_position": null, "vc_priority": null, "comments": "", "local_context_data": null, "tags": [], "custom_fields": {}, "config_context": {}, "created": "2020-01-14", "last_updated": "2020-01-14T18:39:01.288081Z" }

यह JSON है (जैसा कि हमने अनुरोध किया), आईडी 1 के साथ डिवाइस का वर्णन: क्या कहा जाता है, किस भूमिका के साथ, कौन सा मॉडल, कहां खड़ा है, आदि।

यह एक HTTP अनुरोध की तरह दिखेगा:

  GET /api/dcim/devices/1/ HTTP/1.1 Host: netbox.linkmeup.ru:45127 User-Agent: curl/7.54.0 Accept: application/json; indent=4

तो जवाब दिखेगा:

  HTTP/1.1 200 OK Server: nginx/1.14.0 (Ubuntu) Date: Tue, 21 Jan 2020 15:14:22 GMT Content-Type: application/json Content-Length: 1638 Connection: keep-alive Data

लेन-देन डंप करें ।

अब यह पता करें कि हमने क्या किया है।

HTTP संदेश संरचना

एक HTTP संदेश में तीन भाग होते हैं, जिनमें से केवल पहली आवश्यकता होती है।

स्टार्ट लाइन
सुर्खियों में
संदेश शरीर

स्टार्ट लाइन

HTTP अनुरोध और प्रतिक्रिया की आरंभ रेखाएँ अलग-अलग दिखती हैं।

HTTP अनुरोध

 METHOD URI HTTP_VERSION

विधि यह निर्धारित करती है कि ग्राहक क्या कार्रवाई करना चाहता है: डेटा प्राप्त करें, ऑब्जेक्ट बनाएं, इसे अपडेट करें, इसे हटाएं।
URI - उस संसाधन का पहचानकर्ता, जहाँ ग्राहक पहुँचता है, या दूसरे शब्दों में, संसाधन / दस्तावेज़ का मार्ग।
HTTP_VERSION क्रमशः HTTP संस्करण है। आज, REST के लिए, यह हमेशा 1.1 है।

एक उदाहरण:

 GET /api/dcim/devices/1/ HTTP/1.1

HTTP रिस्पांस

 HTTP_VERSION STATUS_CODE REASON_PHRASE

HTTP_VERSION - HTTP संस्करण (1.1)।
STATUS_CODE - स्टेटस कोड के तीन अंक (200, 404, 502, आदि)
REASON_PHRASE - स्पष्टीकरण (ठीक है, फ़ॉइंड, बीएड गेटवे, आदि)

एक उदाहरण:

 HTTP/1.1 200 OK

सुर्खियों में

शीर्ष लेख इस HTTP लेन-देन के लिए पैरामीटर पास करते हैं।

उदाहरण के लिए, HTTP अनुरोध में ऊपर दिए गए उदाहरण में, ये थे:

  Host: netbox.linkmeup.ru:45127 User-Agent: curl/7.54.0 Accept: application/json; indent=4

वे संकेत करते हैं

हम होस्ट netbox.linkmeup.ru:45127 पर जाते हैं ,
अनुरोध कर्ल में उत्पन्न हुआ था,
और हम JSON प्रारूप में डेटा को 4 के इंडेंटेशन के साथ स्वीकार करते हैं।

और यहाँ HTTP प्रतिक्रिया में हेडर हैं:

  Server: nginx/1.14.0 (Ubuntu) Date: Tue, 21 Jan 2020 15:14:22 GMT Content-Type: application/json Content-Length: 1638 Connection: keep-alive

वे संकेत करते हैं

सर्वर प्रकार: Ubuntu पर nginx ,
प्रतिक्रिया समय
प्रतिक्रिया डेटा प्रारूप: JSON
प्रतिक्रिया डेटा लंबाई: 1638 बाइट्स
कनेक्शन को बंद करने की आवश्यकता नहीं है - अभी भी डेटा होगा।

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

संभावित हेडर की एक पूरी सूची ।

HTTP संदेश का मुख्य भाग

शरीर का उपयोग वास्तविक डेटा को स्थानांतरित करने के लिए किया जाता है।

HTTP प्रतिक्रिया में, यह एक HTML पृष्ठ या हमारे मामले में JSON ऑब्जेक्ट हो सकता है।

हेडर और शरीर के बीच कम से कम एक रिक्त रेखा होनी चाहिए।

HTTP अनुरोध में GET विधि का उपयोग करते समय, आमतौर पर कोई निकाय नहीं होता है क्योंकि संचारित करने के लिए कुछ भी नहीं होता है। लेकिन शरीर HTTP प्रतिक्रिया में है।

लेकिन उदाहरण के लिए, POST के साथ, शरीर पहले से ही अनुरोध में होगा। आइए अब तरीकों के बारे में बात करते हैं और बात करते हैं।

तरीकों

जैसा कि आप पहले ही समझ चुके हैं, HTTP WEB सेवाओं के साथ काम करने के तरीकों का उपयोग करता है। वही RESTful API के लिए जाता है।

संभावित वास्तविक जीवन के परिदृश्यों का वर्णन CRUD - क्रिएट, रीड, अपडेट, डिलीट द्वारा किया गया है ।
यहां सबसे लोकप्रिय HTTP विधियों की एक सूची है जो CRUD को लागू करती है:

HTTP जीईटी
HTTP POST
HTTP PUT
HTTP DELETE
HTTP PATCH

विधियों को क्रिया भी कहा जाता है , क्योंकि वे इंगित करते हैं कि क्या क्रिया की जाती है।

तरीकों की पूरी सूची ।

आइए नेटबॉक्स उदाहरण का उपयोग करके उनमें से प्रत्येक को देखें।

HTTP जीईटी

यह जानकारी प्राप्त करने की एक विधि है।

इसलिए, उदाहरण के लिए, हम उपकरणों की सूची को हटा देते हैं:

 curl -H "Accept: application/json; indent=4" \ http://netbox.linkmeup.ru:45127/api/dcim/devices/

जीईटी विधि सुरक्षित है क्योंकि यह डेटा नहीं बदलता है, लेकिन केवल पूछता है।

यह इस दृष्टि से उदासीन है कि एक ही क्वेरी हमेशा एक ही परिणाम देता है (जब तक कि डेटा स्वयं बदल नहीं गया है)।

GET पर, सर्वर HTTP कोड और प्रतिक्रिया निकाय ( प्रतिक्रिया कोड और प्रतिक्रिया निकाय ) के साथ एक संदेश देता है।

यही है, अगर सब कुछ ठीक है, तो प्रतिक्रिया कोड 200 (ठीक) है।
यदि URL नहीं मिला है, तो 404 (FOUND नहीं)।
यदि सर्वर या घटकों के साथ कुछ गलत है, तो यह 500 (सर्वर त्रुटि) या 502 (बीएडी गेटवे) हो सकता है।
सभी संभव प्रतिक्रिया कोड ।

निकाय को JSON या XML प्रारूप में लौटाया जाता है।

लेन-देन डंप करें ।

चलिए एक दो और उदाहरण देते हैं। अब हम एक विशिष्ट डिवाइस पर उसके नाम से जानकारी का अनुरोध करेंगे।

 curl -X GET -H "Accept: application/json; indent=4" \ "http://netbox.linkmeup.ru:45127/api/dcim/devices/?name=mlg-leaf-0"

यहां, यूआरआई में खोज की शर्तों को निर्धारित करने के लिए, मैंने ऑब्जेक्ट का नाम (इसका नाम पैरामीटर और इसका मान एमएलजी-लीफ -0 ) भी प्रदान किया। जैसा कि आप देख सकते हैं, हालत से पहले और स्लैश के बाद "?" , और नाम और मान को "=" चिह्न द्वारा अलग किया जाता है।

यह अनुरोध जैसा दिखता है।

  GET /api/dcim/devices/?name=mlg-leaf-0 HTTP/1.1 Host: netbox.linkmeup.ru:45127 User-Agent: curl/7.54.0 Accept: application/json; indent=4

लेन-देन डंप करें ।

यदि आपको कुछ शर्तों को निर्दिष्ट करने की आवश्यकता है, तो क्वेरी इस तरह दिखाई देगी:

 curl -X GET -H "Accept: application/json; indent=4" \ "http://netbox.linkmeup.ru:45127/api/dcim/devices/?role=leaf&site=mlg"

यहां हमने mlg वेबसाइट पर स्थित सभी लीफ डिवाइस का अनुरोध किया है।
यही है, दो शर्तों को "और" संकेत द्वारा एक दूसरे से अलग किया जाता है।

लेन-देन डंप करें ।

जिज्ञासु और सुखद से - अगर "और" के माध्यम से आप एक ही नाम के साथ दो स्थितियां निर्धारित करते हैं, तो उनके बीच वास्तव में एक तार्किक "AND" नहीं होगा, लेकिन एक तार्किक "OR" होगा।

यही है, ऐसी क्वेरी वास्तव में दो वस्तुओं को लौटाएगी: एमएलजी-लीफ -0 और एमएलजी-स्पाइन -0

 curl -X GET -H "Accept: application/json; indent=4" \ "http://netbox.linkmeup.ru:45127/api/dcim/devices/?name=mlg-leaf-0&name=mlg-spine-0"

लेन-देन डंप करें ।

आइए एक नॉन-URL URL तक पहुंचने का प्रयास करें।

 curl -X GET -H "Accept: application/json; indent=4" \ "http://netbox.linkmeup.ru:45127/api/dcim/IDGAF/"

लेन-देन डंप करें ।

HTTP POST

POST का उपयोग वस्तुओं के संग्रह में एक नई वस्तु बनाने के लिए किया जाता है। या अधिक जटिल भाषा में: एक नया अधीनस्थ संसाधन बनाने के लिए।

आर्थरिएंटेक से स्पष्टीकरण:
सहित, लेकिन तक सीमित नहीं है। POST विधि को आगे की प्रक्रिया के लिए सर्वर पर डेटा स्थानांतरित करने के लिए डिज़ाइन किया गया है - इसका उपयोग उन कार्यों के लिए किया जाता है जिन्हें HTTP के भीतर मानकीकृत करने की आवश्यकता नहीं है। RFC 5789 से पहले , यह आंशिक परिवर्तन करने का एकमात्र कानूनी तरीका था।
roy.gbiv.com/untangled/2009/it-is-okay-to-use-post
tools.ietf.org/html/rfc7231#section-4.3.3

यही है, अगर उपकरणों का एक सेट है, तो POST आपको उपकरणों के अंदर एक नई डिवाइस ऑब्जेक्ट बनाने की अनुमति देता है।

एक ही एंडपॉइंट चुनें और एक नया डिवाइस बनाने के लिए POST का उपयोग करें।

 curl -X POST "http://netbox.linkmeup.ru:45127/api/dcim/devices/" \ -H "accept: application/json"\ -H "Content-Type: application/json" \ -H "Authorization: TOKEN a9aae70d65c928a554f9a038b9d4703a1583594f" \ -d "{ \"name\": \"just a simple russian girl\", \"device_type\": 1, \"device_role\": 1, \"site\": 3, \"rack\": 3, \"position\": 5, \"face\": \"front\"}"

एक प्राधिकरण हेडर पहले से ही यहां दिखाई देता है, जिसमें एक टोकन होता है जो लिखने के अनुरोध को अधिकृत करता है, और -d निर्देश के बाद JSON निर्मित डिवाइस के मापदंडों के साथ होता है:

 { "name": "just a simple russian girl", "device_type": 1, "device_role": 1, "site": 3, "rack": 3, "position": 5, "face": "front"}

आपका अनुरोध काम नहीं करेगा, क्योंकि टोकन अब मान्य नहीं है - नेटबॉक्स को लिखने का प्रयास न करें।

प्रतिक्रिया संदेश के शरीर में कोड 201 (निर्मित) और JSON के साथ HTTP प्रतिक्रिया के साथ आती है, जहां सर्वर निर्मित डिवाइस के बारे में सभी मापदंडों को वापस करता है।

  HTTP/1.1 201 Created Server: nginx/1.14.0 (Ubuntu) Date: Sat, 18 Jan 2020 11:00:22 GMT Content-Type: application/json Content-Length: 1123 Connection: keep-alive JSON

लेन-देन डंप करें ।

अब, GET विधि के साथ एक नए अनुरोध के साथ, आप इसे आउटपुट में देख सकते हैं:

 curl -X GET -H "Accept: application/json; indent=4" \ "http://netbox.linkmeup.ru:45127/api/dcim/devices/?q=russian"

नेटबॉक्स में "क्यू" आपको उन सभी वस्तुओं को खोजने की अनुमति देता है जो उनके नाम में शामिल हैं एक पंक्ति जो आगे जाती है।

POST, स्पष्ट रूप से, न तो सुरक्षित है और न ही बेकार - यह संभवतः डेटा को बदलता है, और एक डबल-निष्पादित अनुरोध या तो दूसरी समान ऑब्जेक्ट के निर्माण या त्रुटि के लिए ले जाएगा।

HTTP PUT

यह किसी मौजूदा वस्तु को संशोधित करने की एक विधि है। PUT के लिए समापन बिंदु POST की तुलना में भिन्न दिखता है - इसमें अब एक विशिष्ट ऑब्जेक्ट है।

PUT कोड 201 या 200 वापस कर सकता है।

इस विधि के साथ एक महत्वपूर्ण बिंदु: आपको सभी आवश्यक विशेषताओं को पास करना होगा, क्योंकि PUT पुरानी वस्तु को बदल देता है।

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

 curl -X PUT "http://netbox.linkmeup.ru:45127/api/dcim/devices/18/" \ -H "accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: TOKEN a9aae70d65c928a554f9a038b9d4703a1583594f" \ -d "{ \"asset_tag\": \"12345678\"}"

 {"device_type":["This field is required."],"device_role":["This field is required."],"site":["This field is required."]}

लेकिन यदि आप लापता फ़ील्ड जोड़ते हैं, तो सब कुछ काम करेगा:

 curl -X PUT "http://netbox.linkmeup.ru:45127/api/dcim/devices/18/" \ -H "accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: TOKEN a9aae70d65c928a554f9a038b9d4703a1583594f" \ -d "{ \"name\": \"just a simple russian girl\", \"device_type\": 1, \"device_role\": 1, \"site\": 3, \"rack\": 3, \"position\": 5, \"face\": \"front\", \"asset_tag\": \"12345678\"}"

लेन-देन डंप करें ।

यहां URL पर ध्यान दें - अब इसमें उस डिवाइस की आईडी शामिल है जिसे हम बदलना चाहते हैं ( 18 )।

HTTP PATCH

इस विधि का उपयोग संसाधन को आंशिक रूप से संशोधित करने के लिए किया जाता है।
WAT? आप पूछते हैं, लेकिन PUT का क्या?

PUT एक विधि है जो मूल रूप से मानक में मौजूद है, जिसमें एक उत्परिवर्तित वस्तु का पूर्ण प्रतिस्थापन शामिल है। तदनुसार, पीयूटी विधि में, जैसा कि मैंने ऊपर लिखा था, आपको ऑब्जेक्ट की उन विशेषताओं को भी निर्दिष्ट करना होगा जो बदलते नहीं हैं।

और PATCH को बाद में जोड़ा गया था और आपको केवल उन विशेषताओं को निर्दिष्ट करने की अनुमति देता है जो वास्तव में बदलते हैं।

उदाहरण के लिए:

 curl -X PATCH "http://netbox.linkmeup.ru:45127/api/dcim/devices/18/" \ -H "accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: TOKEN a9aae70d65c928a554f9a038b9d4703a1583594f" \ -d "{ \"serial\": \"BREAKINGBAD\"}"

यहां, डिवाइस आईडी URL में भी निर्दिष्ट है, लेकिन बदलने के लिए केवल एक सीरियल विशेषता है।

लेन-देन डंप करें ।

HTTP DELETE

स्पष्ट रूप से वस्तु को हटाता है।

एक उदाहरण है।

 curl -X DELETE "http://netbox.linkmeup.ru:45127/api/dcim/devices/21/" \ -H "accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: TOKEN a9aae70d65c928a554f9a038b9d4703a1583594f"

DELETE पद्धति इस दृष्टिकोण से उदासीन है कि एक दोहराया गया क्वेरी अब संसाधनों की सूची में कुछ भी नहीं बदलता है (लेकिन कोड 404 (NOT FOUND) को वापस कर देगा)।

 curl -X DELETE "http://netbox.linkmeup.ru:45127/api/dcim/devices/21/" \ -H "accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: TOKEN a9aae70d65c928a554f9a038b9d4703a1583594f"

 {"detail":"Not found."}

रेस्टफुल एपीआई के साथ काम करने के तरीके

बेशक, बहादुर सीएलआई योद्धाओं के लिए बहुत सुविधाजनक है, लेकिन बेहतर उपकरण हैं।

पत्रवाहक

पोस्टमैन आपको तरीकों, हेडर, बॉडी का चयन करके ग्राफिकल इंटरफ़ेस में प्रश्न बनाने की अनुमति देता है, और परिणाम को मानव-पठनीय रूप में प्रदर्शित करता है।

इसके अतिरिक्त, क्वेरी और यूआरआई को बचाया जा सकता है और बाद में उन्हें वापस किया जा सकता है।

पोस्टमैन को आधिकारिक वेबसाइट पर डाउनलोड करें ।

तो हम एक GET कर सकते हैं:

यहाँ टोकन को केवल उदाहरण के रूप में GET में दर्शाया गया है।

और इसलिए पोस्ट:

Postman केवल RESTful API के साथ उपयोग के लिए है।

उदाहरण के लिए, NETCONF XML को इसके माध्यम से भेजने की कोशिश न करें, जैसा कि मैंने अपने स्वचालन कैरियर की शुरुआत में किया था।

निर्दिष्ट एपीआई के अच्छे बोनस में से एक यह है कि आप एक संग्रह के रूप में पोस्टमैन में सभी समापन बिंदुओं और उनके तरीकों को आयात कर सकते हैं।

ऐसा करने के लिए, आयात विंडो (फ़ाइल-> आयात) में, लिंक से आयात करें चुनें और विंडो netbox.linkmeup.ru URL में पेस्ट करें: 45127 / एपीआई / डॉक्स /? प्रारूप = ओपेनपी।

इसके अलावा, सब कुछ आप संग्रह में पाया जा सकता है।

पायथन + अनुरोध

लेकिन यहां तक कि पोस्टमैन के माध्यम से, आप सबसे अधिक संभावना अपने उत्पादन प्रणालियों का प्रबंधन नहीं करेंगे। निश्चित रूप से, आपके पास बाहरी अनुप्रयोग होंगे जो आपकी भागीदारी के बिना उनके साथ बातचीत करना चाहते हैं।

उदाहरण के लिए, एक कॉन्फ़िगरेशन जेनरेशन सिस्टम NetBox से IP इंटरफेस की एक सूची चुनना चाहता है।
पायथन में अनुरोधों का एक अद्भुत पुस्तकालय है जो HTTP के माध्यम से काम करता है।
सभी उपकरणों की सूची का अनुरोध करने का एक उदाहरण:

 import requests HEADERS = {'Content-Type': 'application/json', 'Accept': 'application/json'} NB_URL = "http://netbox.linkmeup.ru:45127" request_url = f"{NB_URL}/api/dcim/devices/" devices = requests.get(request_url, headers = HEADERS) print(devices.json())

फिर से एक नया उपकरण जोड़ें:

 import requests API_TOKEN = "a9aae70d65c928a554f9a038b9d4703a1583594f" HEADERS = {'Authorization': f'Token {API_TOKEN}', 'Content-Type': 'application/json', 'Accept': 'application/json'} NB_URL = "http://netbox.linkmeup.ru:45127" request_url = f"{NB_URL}/api/dcim/devices/" device_parameters = { "name": "just a simple REQUESTS girl", "device_type": 1, "device_role": 1, "site": 3, } new_device = requests.post(request_url, headers = HEADERS, json=device_parameters) print(new_device.json())

पायथन + नेटबॉक्स एसडीके

नेटबॉक्स के मामले में, एक पायथन SDK - Pynetbox भी है , जो एक वस्तु और इसकी विशेषताओं के रूप में सभी NetBox समापन बिंदुओं का प्रतिनिधित्व करता है, जिससे आप URI उत्पन्न करने और प्रतिक्रिया को पार्स करने के लिए सभी गंदे काम कर रहे हैं, हालांकि, बिल्कुल मुफ्त नहीं।

उदाहरण के लिए, चलो pynetbox का उपयोग करके ऊपर जैसा करते हैं, वैसा ही करें।
सभी उपकरणों की सूची:

 import pynetbox NB_URL = "http://netbox.linkmeup.ru:45127" nb = pynetbox.api(NB_URL) devices = nb.dcim.devices.all() print(devices)

नया उपकरण जोड़ें:

 import pynetbox API_TOKEN = "a9aae70d65c928a554f9a038b9d4703a1583594f" NB_URL = "http://netbox.linkmeup.ru:45127" nb = pynetbox.api(NB_URL, token = API_TOKEN) device_parameters = { "name": "just a simple PYNETBOX girl", "device_type": 1, "device_role": 1, "site": 3, } new_device = nb.dcim.devices.create(**device_parameters) print(new_device)

Pynetbox प्रलेखन

अकड़

पिछले एक दशक के लिए धन्यवाद के लायक और क्या है एपीआई विनिर्देश। यदि आप इस पथ का अनुसरण करते हैं , तो आपको स्वैगर UI - नेटबॉक्स एपीआई प्रलेखन में ले जाया जाएगा।

यह पृष्ठ सभी समापन बिंदुओं, उनके साथ काम करने के तरीकों, संभावित मापदंडों और विशेषताओं को इंगित करता है और इंगित करता है कि उनमें से कौन से आवश्यक हैं। इसके अलावा, अपेक्षित उत्तर वर्णित हैं।

उसी पृष्ठ पर, आप इसे आज़माएं पर क्लिक करके इंटरैक्टिव प्रश्न कर सकते हैं।

किसी कारण से, स्वैगर बेस URL के रूप में पोर्ट के बिना सर्वर का नाम लेता है, इसलिए इसे आज़माएं फ़ंक्शन मेरे स्वैगर उदाहरणों में काम नहीं करता है। लेकिन आप इसे अपनी स्थापना पर आज़मा सकते हैं।

जब आप Execute Swagger पर क्लिक करते हैं, तो UI एक कर्ल स्ट्रिंग उत्पन्न करेगा जिसका उपयोग कमांड लाइन से समान अनुरोध करने के लिए किया जा सकता है।

स्वैगर UI में, आप एक ऑब्जेक्ट भी बना सकते हैं:

ऐसा करने के लिए, आवश्यक अधिकारों के साथ अधिकृत उपयोगकर्ता होना पर्याप्त है।

हम इस पृष्ठ पर जो देखते हैं वह Swagger UI है, जो API विनिर्देश के आधार पर बनाया गया एक दस्तावेज है।

माइक्रोसॉर्स्क आर्किटेक्चर के रुझानों के साथ, घटकों के बीच बातचीत के लिए एक मानकीकृत एपीआई का होना बहुत महत्वपूर्ण होता जा रहा है, जो एंडपॉइंट और तरीके दोनों व्यक्ति और एप्लिकेशन के लिए निर्धारित करना आसान है, स्रोत कोड या पीडीएफ प्रलेखन के माध्यम से अफवाह के बिना।

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

स्वैगर एक फ्रेमवर्क और विनिर्देश भाषा है (जिसे अब ओपनएपीआई 2.0 नाम दिया गया है), जिससे आप इस कार्य को कार्यान्वित कर सकते हैं।
मैं इसमें गहराई तक नहीं जाऊंगा।

अधिक जानकारी के लिए यहाँ:

आरईएसटी और विकल्प की आलोचना

एक है, हाँ। वर्ष 2000 की उस दुनिया में सब कुछ पहले से ही इतना रसपूर्ण नहीं है।

एक विशेषज्ञ नहीं होने के नाते, मैं इस मुद्दे का लगातार खुलासा करने के लिए नहीं मानता हूं, लेकिन मैं हैबर पर एक निर्विवाद लेख का लिंक दूंगा ।

आज सिस्टम घटकों के इंटरैक्शन के लिए एक वैकल्पिक इंटरफ़ेस जीआरपीसी है। उन्होंने नेटवर्क उपकरणों के साथ काम करने के लिए नए दृष्टिकोणों के क्षेत्र में एक महान भविष्य की भविष्यवाणी की। लेकिन हम भविष्य में कभी उसकी बात करेंगे, जब उसकी बारी आएगी।

आप होनहार ग्राफ़कॉक पर भी नज़र डाल सकते हैं , लेकिन फिर भी हमें इसके साथ काम करने की ज़रूरत नहीं है, इसलिए यह हमारे लिए अध्ययन करना बाकी है।

महत्वपूर्ण है
टोकन a9aae70d65c928a554f9a038b9d4703a1583594f केवल प्रदर्शन उद्देश्यों के लिए उपयोग किया गया था और अब काम नहीं करता है।

कार्यक्रम कोड में टोकन का प्रत्यक्ष संकेत अस्वीकार्य है और मैंने यहां केवल उदाहरणों को सरल बनाने के हितों में बनाया है।

उपयोगी लिंक

धन्यवाद

प्रूफरीडिंग और एडिटिंग के लिए आंद्रेई पैनफिलोव
अलेक्जेंडर फतिन प्रूफरीडिंग और एडिटिंग के लिए

सबसे छोटे के लिए स्वचालन। नोट्स। रेस्टफुल एपीआई