MediaWiki API คือชุดเครื่องมือสำหรับการพัฒนาที่มีเอกสารประกอบมาอย่างดี ซึ่งสามารถทำงานส่วนใหญ่ได้ในสคริปต์เดียว โดยทั่วไปแล้ว API จะใช้สำหรับการพัฒนาเครื่องมืออัตโนมัติสำหรับใช้ในวิกิ MediaWiki API สามารถใช้ได้กับภาษาส่วนใหญ่อย่างง่ายดาย โดยเฉพาะ PHP (ฟังก์ชัน curl) เช่นเดียวกับ Perl และอีกสองสามภาษา..
ขั้นตอน
ขั้นตอนที่ 1 อ่านเอกสาร MediaWiki API
มันอยู่ที่ 'api.php' ในไดเร็กทอรีเดียวกันกับ index.php ปกติ ตัวอย่าง:
ขั้นตอนที่ 2 เลือกรูปแบบผลลัพธ์
มีเดียวิกินำเสนอข้อมูลในรูปแบบ JSON, JSONFM, PHP (รูปแบบซีเรียลไลซ์), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM และ RAWFM รูปแบบที่ต่อท้าย "FM" นั้นค่อนข้างพิมพ์เป็น HTML
ขั้นตอนที่ 3 เลือกการดำเนินการ
MediaWiki API รองรับการดำเนินการต่อไปนี้:
- ช่วยเหลือ - ดูหน้าจอช่วยเหลือ
- เข้าสู่ระบบ - เข้าสู่ระบบมีเดียวิกิ
- opensearch - ใช้โปรโตคอล opensearch (การติดตั้งมีเดียวิกิบางรายการไม่มีสิ่งนี้)
- feedwatchlist - ส่งคืนฟีดรายการเฝ้าดู
- แบบสอบถาม - มีตัวเลือกที่หลากหลาย ดูเอกสาร MediaWiki API สำหรับพวกเขา
ขั้นตอนที่ 4 เลือกแบบสอบถามหรือรายการ
นอกจากการดำเนินการมาตรฐานแล้ว MediaWiki ยังสนับสนุนการสืบค้นและรายการต่างๆ เช่น หน้ารายการที่มีลิงก์ไปยังบทความอื่น จำนวนการเปลี่ยนแปลงล่าสุด การมีส่วนร่วม ฯลฯ
ขั้นตอนที่ 5 ส่งข้อมูลที่โพสต์ไปยัง API ผ่านการใช้ CURL หรือเครื่องมืออื่นที่อนุญาตให้คุณใช้วิธีการ POST ไปยังสคริปต์
วิธี GET อาจใช้ได้เช่นกัน
ขั้นตอนที่ 6 ตรวจสอบให้แน่ใจว่าได้เก็บคุกกี้ที่ส่งไปยังแอปพลิเคชัน (บางสคริปต์/แอปพลิเคชันอาจต้องการจัดเก็บไว้ในโฟลเดอร์ย่อย
ขั้นตอนที่ 7 เมื่อโต้ตอบกับอินเทอร์เฟซผู้ใช้มีเดียวิกิ โปรดทราบว่าโทเค็นการแก้ไขของคุณจะถูกเก็บไว้ในหน้าแก้ไขส่วนใหญ่
โทเค็นการแก้ไขใช้เพื่อระบุการชนกันของการแก้ไขและหลีกเลี่ยงการแทนที่การแก้ไขอื่นที่ทำไปแล้ว (ใช้ในการย้อนกลับเช่นกัน) พึงระลึกไว้เสมอว่าสิ่งต่าง ๆ จะผิดพลาดได้ง่ายขึ้นหากคุณดำเนินการกับส่วนต่อประสานผู้ใช้ของวิกิ คำนึงถึง regexes ที่คุณใช้เพื่อให้แน่ใจว่าพวกเขาจะทำเฉพาะผลลัพธ์ที่ต้องการ
ขั้นตอนที่ 8 อ่านผลลัพธ์ที่ส่งโดยวิกิ
ผลลัพธ์จะถูกส่งถึงคุณในการตอบสนอง HTTP ซึ่ง parsers จำนวนมากสามารถอ่านได้ ดูแลรูปแบบที่คุณเลือกเป็นพิเศษ ตรวจสอบให้แน่ใจว่าคุณใช้ parser ที่เหมาะสมสำหรับรูปแบบนั้น แนวทางปฏิบัติที่ดีในการระบุรูปแบบไปยังมีเดียวิกิอย่างชัดเจนแม้ว่าจะมีรูปแบบเริ่มต้นที่คุณต้องการใช้ก็ตาม
เคล็ดลับ
- ตรวจสอบให้แน่ใจว่าคุณได้รับการสนับสนุนสคริปต์จากวิกิในพื้นที่ของคุณก่อนที่จะใช้ API
- คุณสามารถหาข้อมูลเพิ่มเติมเกี่ยวกับมีเดียวิกิได้โดยใช้ API
