मीडियाविकि एपीआई विकास उपकरणों का एक अच्छी तरह से प्रलेखित सेट है जो एक स्क्रिप्ट में अधिकांश कार्य कर सकता है। एपीआई का उपयोग आमतौर पर विकि में उपयोग के लिए स्वचालित उपकरणों के विकास के लिए किया जाता है। MediaWiki API का उपयोग अधिकांश भाषाओं, विशेष रूप से PHP (कर्ल फ़ंक्शंस) के साथ-साथ पर्ल और कुछ अन्य द्वारा आसानी से किया जा सकता है।
कदम
चरण 1. MediaWiki API दस्तावेज़ पढ़ें।
यह सामान्य index.php के समान निर्देशिका में 'api.php' पर स्थित है। उदाहरण:
चरण 2. एक आउटपुट स्वरूप का चयन करें।
MediaWiki JSON, JSONFM, PHP (क्रमबद्ध प्रारूप), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM, और RAWFM के रूप में डेटा आउटपुट प्रदान करता है। "FM" प्रत्यय वाले प्रारूप HTML में सुंदर-प्रिंट हैं।
चरण 3. एक क्रिया चुनें।
मीडियाविकि एपीआई निम्नलिखित क्रियाओं का समर्थन करता है:
- सहायता - सहायता स्क्रीन देखें
- लॉगिन - मीडियाविकि में लॉगिन करें
- ओपनसर्च - ओपनसर्च प्रोटोकॉल को लागू करें। (सभी मीडियाविकि संस्थापनों में यह नहीं है)।
- फीडवॉचलिस्ट - एक वॉचलिस्ट फ़ीड लौटाएं।
- क्वेरी - विभिन्न प्रकार के विकल्प हैं। उनके लिए MediaWiki API दस्तावेज़ देखें।
चरण 4. कोई प्रश्न या सूची चुनें।
मानक क्रियाओं के अलावा, मीडियाविकि विभिन्न प्रश्नों और सूचियों का समर्थन करता है, जैसे सूची पृष्ठ जिनमें किसी अन्य लेख का लिंक होता है, हाल के परिवर्तनों की संख्या भिन्न होती है, योगदान आदि।
चरण 5। पोस्ट किए गए डेटा को CURL या किसी अन्य टूल के उपयोग के माध्यम से API को पास करें जो आपको स्क्रिप्ट के लिए POST विधि का उपयोग करने की अनुमति देता है।
जीईटी विधि भी काम कर सकती है।
चरण 6. किसी एप्लिकेशन को भेजी गई कुकीज़ रखना सुनिश्चित करें (कुछ स्क्रिप्ट/एप्लिकेशन इसे सबफ़ोल्डर में संग्रहीत करना चाह सकते हैं।
चरण 7. MediaWiki उपयोगकर्ता इंटरफ़ेस के साथ बातचीत करते समय, अधिकांश संपादन पृष्ठों में रखे गए अपने संपादन टोकन पर ध्यान दें।
संपादन टोकन का उपयोग संपादन टकरावों को निर्धारित करने और पहले से किए गए किसी अन्य संपादन को ओवरराइड करने से बचने के लिए किया जाता है (इसका उपयोग रोलबैक में भी किया जाता है।) ध्यान रखें कि यदि आप विकी के यूजर इंटरफेस के साथ काम कर रहे हैं तो चीजें गड़बड़ा सकती हैं। यह सुनिश्चित करने के लिए आपके द्वारा उपयोग किए जाने वाले किसी भी रेगेक्स से सावधान रहें कि वे केवल इच्छित परिणाम ही करेंगे।
चरण 8. विकी द्वारा भेजे गए परिणाम पढ़ें।
परिणाम आपको एक HTTP प्रतिक्रिया में भेजे जाएंगे, जिसे कई पार्सर्स पढ़ सकते हैं। आपके द्वारा चुने गए प्रारूप का अतिरिक्त ध्यान रखें। सुनिश्चित करें कि आप उस प्रारूप के लिए उपयुक्त पार्सर का उपयोग करते हैं। मीडियाविकि को प्रारूप को स्पष्ट रूप से बताना एक अच्छा अभ्यास है, भले ही उसके पास एक डिफ़ॉल्ट प्रारूप है जिसका आप उपयोग करना चाहते हैं।
टिप्स
- सुनिश्चित करें कि एपीआई का उपयोग करने से पहले आपके पास स्क्रिप्ट के लिए आपके स्थानीय विकी का समर्थन है।
- आप मीडियाविकि के बारे में इसके एपीआई का उपयोग करके अधिक जानकारी प्राप्त कर सकते हैं।
