API:หน้าหลัก

หน้านี้แสดงภาพรวมของ MediaWiki Action API หน้านี้มีไว้สำหรับผู้ร่วมให้ข้อมูลด้านเทคนิคและนักพัฒนาซอฟต์แวร์ที่ต้องการทำความเข้าใจและใช้ MediaWiki Action API

เริ่มต้นแบบรวดเร็ว

รับเนื้อหาของบทความในวิกิพีเดียภาษาอังกฤษในรูปแบบ HTML:

api.php?action=parse&page=Pet_door&format=json [ลองใช้ในกระบะทรายเอพีไอ]

Endpoint

วิกิมีเดียวิกิ (Wikimedia wiki) ทั้งหมดมี endpoint ที่เป็นไปตามรูปแบบนี้: https://www.example.org/w/api.php

ตัวอย่างของวิกิมีเดีย Wiki Endpoint

API Endpoint	วิกิ
https://www.mediawiki.org/w/api.php	MediaWiki API
https://meta.wikimedia.org/w/api.php	Meta-Wiki API
https://en.wikipedia.org/w/api.php	English Wikipedia API
https://nl.wikipedia.org/w/api.php	Dutch Wikipedia API
https://commons.wikimedia.org/w/api.php	Wikimedia Commons API
https://test.wikipedia.org/w/api.php	Test Wiki API

หากต้องการดู endpoint URL ในวิกิใด ให้ดูส่วน "ยูอาร์แอลจุดเข้า" ในหน้า Special:Version

บทนำ

MediaWiki Action API คือ web service ที่อนุญาตให้เข้าถึงฟีเจอร์บางอย่างของ Wiki เช่น การรับรองความถูกต้อง (authentication) การทำงานของเพจ (page operations) และการค้นหา (search) สามารถให้ ข้อมูลเมทา เกี่ยวกับวิกิและผู้ใช้ที่เข้าสู่ระบบได้

การใช้งานสำหรับ MediaWiki Action API

• ตรวจสอบ (Monitor) การติดตั้งมีเดียวิกิ (MediaWiki)
• สร้างบอท เพื่อรักษาการติดตั้ง MediaWiki
• ล็อกอินเข้าสู่วิกิ เข้าถึงข้อมูล และโพสต์การเปลี่ยนแปลงโดยส่งคำขอ HTTP ไปยัง web service

เริ่มต้นใช้งานกับ MediaWiki Action API

ก่อนที่คุณจะเริ่มใช้ MediaWiki Action API คุณควรตรวจสอบหน้าต่อไปนี้:

• มารยาทและแนวทางการใช้งาน API
• คำถามที่พบบ่อย (FAQ)
• input และ output formats
• ข้อบกพร่องและการเตือน
• นโยบายใดๆ ที่ใช้กับวิกิที่คุณต้องการเข้าถึง เช่น ข้อกำหนดการใช้งาน และ นโยบายเครื่องหมายการค้า ของมูลนิธิวิกิมีเดีย (Wikimedia Foundation) ข้อกำหนดเหล่านี้มีผลกับคุณเมื่อคุณเข้าถึงหรือแก้ไขโดยใช้ API เช่นเดียวกับเมื่อคุณใช้เว็บเบราว์เซอร์ของคุณ

API documentation

Main module Source: MediaWiki License: GPL-2.0-or-later Documentation Etiquette & usage guidelines FAQ Mailing list API Announcements Bugs & requests Status: The MediaWiki API is a mature and stable interface that is actively supported and improved. While we try to avoid it, we may occasionally need to make breaking changes; subscribe to the mediawiki-api-announce mailing list for notice of updates. Erroneous requests: When erroneous requests are sent to the API, an HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see API: Errors and warnings. Testing: For ease of testing API requests, see Special:ApiSandbox. Parameters: action Which action to perform. abusefiltercheckmatch Check to see if an AbuseFilter matches a set of variables, an edit, or a logged AbuseFilter event. abusefilterchecksyntax Check syntax of an AbuseFilter filter. abusefilterevalexpression Evaluates an AbuseFilter expression. abusefilterunblockautopromote Unblocks a user from receiving autopromotions due to an abusefilter consequence. abuselogprivatedetails View private details of an AbuseLog entry. aggregategroups Manage aggregate message groups. antispoof Check a username against AntiSpoof's normalisation checks. block Block a user. centralauthtoken Fetch a centralauthtoken for making an authenticated request to an attached wiki. centralnoticecdncacheupdatebanner Request the purge of banner content stored in the CDN (front-end) cache for anonymous users, for the requested banner and language centralnoticechoicedata Get data needed to choose a banner for a given project and language centralnoticequerycampaign Get all configuration settings for a campaign. changeauthenticationdata Change authentication data for the current user. changecontentmodel Change the content model of a page checktoken Check the validity of a token from action=query&meta=tokens. cirrus-config-dump Dump of CirrusSearch configuration. cirrus-mapping-dump Dump of CirrusSearch mapping for this wiki. cirrus-profiles-dump Dump of CirrusSearch profiles for this wiki. cirrus-settings-dump Dump of CirrusSearch settings for this wiki. clearhasmsg Clears the hasmsg flag for the current user. clientlogin Log in to the wiki using the interactive flow. compare Get the difference between two pages. createaccount Create a new user account. createlocalaccount Forcibly create a local account delete Delete a page. deleteglobalaccount Delete a global user. echomarkread Mark notifications as read for the current user. echomarkseen Mark notifications as seen for the current user. echomute Mute or unmute notifications from certain users or pages. edit Create and edit pages. editmassmessagelist Edit a mass message delivery list. emailuser Email a user. expandtemplates Expands all templates within wikitext. fancycaptchareload Get a new FancyCaptcha. featuredfeed Returns a featured content feed. feedcontributions Returns a user's contributions feed. feedrecentchanges Returns a recent changes feed. feedthreads Return a feed of discussion threads. feedwatchlist Returns a watchlist feed. filerevert Revert a file to an old version. flow Allows actions to be taken on Structured Discussions pages. flow-parsoid-utils Convert text between wikitext and HTML. flowthank Send a public thank-you notification for a Flow comment. globalblock Globally block or unblock a user. globalpreferenceoverrides Change local overrides for global preferences for the current user. globalpreferences Change global preferences of the current user. globaluserrights Add/remove a user to/from global groups. graph Access graph tag functionality. groupreview Set message group workflow states. help Display help for the specified modules. imagerotate This module has been disabled. import Import a page from another wiki, or from an XML file. jsonconfig Allows direct access to JsonConfig subsystem. languagesearch Search for language names in any script. linkaccount Link an account from a third-party provider to the current user. login Log in and get authentication cookies. logout Log out and clear session data. managetags Perform management tasks relating to change tags. massmessage Send a message to a list of pages. mergehistory Merge page histories. move Move a page. newslettersubscribe Subscribe to or unsubscribe from a newsletter. opensearch Search the wiki using the OpenSearch protocol. options Change preferences of the current user. paraminfo Obtain information about API modules. parse Parses content and returns parser output. patrol Patrol a page or revision. protect Change the protection level of a page. purge Purge the cache for the given titles. query Fetch data from and about MediaWiki. removeauthenticationdata Remove authentication data for the current user. resetpassword Send a password reset email to a user. revisiondelete Delete and undelete revisions. rollback Undo the last edit to the page. rsd Export an RSD (Really Simple Discovery) schema. searchtranslations Search translations. setglobalaccountstatus Set a global user's status. setnotificationtimestamp Update the notification timestamp for watched pages. setpagelanguage Change the language of a page. shortenurl Shorten a long URL into a shorter one. sitematrix Get Wikimedia sites list. spamblacklist Validate one or more URLs against the spam block list. streamconfigs Exposes event stream config. Returns only format=json with formatversion=2. strikevote Allows admins to strike or unstrike a vote. tag Add or remove change tags from individual revisions or log entries. templatedata Fetch data stored by the TemplateData extension. thank Send a thank-you notification to an editor. threadaction Allows actions to be taken on threads and posts in threaded discussions. titleblacklist Validate a page title, filename, or username against the TitleBlacklist. transcodereset Users with the 'transcode-reset' right can reset and re-run a transcode job. translationaids Query all translations aids. translationreview Mark translations reviewed. translationstats Fetch translation statistics ttmserver Query suggestions from translation memories. unblock Unblock a user. undelete Undelete revisions of a deleted page. unlinkaccount Remove a linked third-party account from the current user. upload Upload a file, or get the status of pending uploads. userrights Change a user's group membership. validatepassword Validate a password against the wiki's password policies. watch Add or remove pages from the current user's watchlist. webapp-manifest Returns a webapp manifest. webauthn API Module to communicate between server and client during registration/authentication process wikilove Give WikiLove to another user. bouncehandler Internal. Receive a bounce email and process it to handle the failing recipient. categorytree Internal. Internal module for the CategoryTree extension. collection Internal. API module for performing various operations on a wiki user's collection. cspreport Internal. Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser. discussiontoolscompare Internal. Get information about comment changes between two page revisions. discussiontoolsedit Internal. Post a message on a discussion page. discussiontoolsgetsubscriptions Internal. Get the subscription statuses of given topics. discussiontoolspageinfo Internal. Returns metadata required to initialize the discussion tools. discussiontoolspreview Internal. Preview a message on a discussion page. discussiontoolssubscribe Internal. Subscribe (or unsubscribe) to receive notifications about a topic. jsondata Internal. Retrieve localized JSON data. managegroupsynchronizationcache Internal. Manage group synchronization cache. managemessagegroups Internal. Add a message as a rename of an existing message or a new message in the group during imports oathvalidate Internal. Validate a two-factor authentication (OATH) token. readinglists Internal. Reading list write operations. record-lint Internal. Record a lint error in the database sanitize-mapdata Internal. Performs data validation for Kartographer extension scribunto-console Internal. Internal module for servicing XHR requests from the Scribunto console. stashedit Internal. Prepare an edit in shared cache. timedtext Internal. Provides timed text content for usage by <track> elements translationcheck Internal. Validate translations. translationentitysearch Internal. Search for message groups and messages ulslocalization Internal. Get the localization of ULS in the given language. ulssetlang Internal. Update user's preferred interface language. visualeditor Internal. Returns HTML5 for a page from the Parsoid service. visualeditoredit Internal. Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service). One of the following values: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, aggregategroups, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, compare, createaccount, createlocalaccount, delete, deleteglobalaccount, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, fancycaptchareload, featuredfeed, feedcontributions, feedrecentchanges, feedthreads, feedwatchlist, filerevert, flow-parsoid-utils, flow, flowthank, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, graph, groupreview, help, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, move, newslettersubscribe, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, searchtranslations, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, streamconfigs, strikevote, tag, templatedata, thank, threadaction, titleblacklist, transcodereset, translationaids, translationreview, translationstats, ttmserver, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, wikilove, bouncehandler, categorytree, collection, cspreport, discussiontoolscompare, discussiontoolsedit, discussiontoolsgetsubscriptions, discussiontoolspageinfo, discussiontoolspreview, discussiontoolssubscribe, jsondata, managegroupsynchronizationcache, managemessagegroups, oathvalidate, readinglists, record-lint, sanitize-mapdata, scribunto-console, stashedit, timedtext, translationcheck, translationentitysearch, ulslocalization, ulssetlang, visualeditor, visualeditoredit Default: help format The format of the output. json Output data in JSON format. jsonfm Output data in JSON format (pretty-print in HTML). none Output nothing. php Output data in serialized PHP format. phpfm Output data in serialized PHP format (pretty-print in HTML). rawfm Output data, including debugging elements, in JSON format (pretty-print in HTML). xml Output data in XML format. xmlfm Output data in XML format (pretty-print in HTML). One of the following values: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm Default: jsonfm maxlag Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code maxlag is returned with a message like Waiting for $host: $lag seconds lagged. See Manual: Maxlag parameter for more information. Type: integer smaxage Set the s-maxage HTTP cache control header to this many seconds. Errors are never cached. Type: integer Default: 0 maxage Set the max-age HTTP cache control header to this many seconds. Errors are never cached. Type: integer Default: 0 assert Verify that the user is logged in if set to user, not logged in if set to anon, or has the bot user right if bot. One of the following values: anon, bot, user assertuser Verify the current user is the named user. Type: user, by username requestid Any value given here will be included in the response. May be used to distinguish requests. servedby Include the hostname that served the request in the results. Type: boolean (details) curtimestamp Include the current timestamp in the result. Type: boolean (details) responselanginfo Include the languages used for uselang and errorlang in the result. Type: boolean (details) origin When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). For authenticated requests, this must match one of the origins in the Origin header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is allowed, the Access-Control-Allow-Origin and Access-Control-Allow-Credentials headers will be set. For non-authenticated requests, specify the value *. This will cause the Access-Control-Allow-Origin header to be set, but Access-Control-Allow-Credentials will be false and all user-specific data will be restricted. uselang Language to use for message translations. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify user to use the current user's language preference, or specify content to use this wiki's content language. Default: user variant Variant of the language. Only works if the base language supports variant conversion. errorformat Format to use for warning and error text output plaintext Wikitext with HTML tags removed and entities replaced. wikitext Unparsed wikitext. html HTML raw Message key and parameters. none No text output, only the error codes. bc Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored. One of the following values: bc, html, none, plaintext, raw, wikitext Default: bc errorlang Language to use for warnings and errors. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify content to use this wiki's content language, or specify uselang to use the same value as the uselang parameter. Default: uselang errorsuselocal If given, error texts will use locally-customized messages from the MediaWiki namespace. Type: boolean (details) centralauthtoken When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use action=centralauthtoken on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body). Examples: Help for the main module. api.php?action=help [open in sandbox] All help in one page. api.php?action=help&recursivesubmodules=1 [open in sandbox] Permissions: writeapi Use of the write API Granted to: all, user and bot apihighlimits Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters. Granted to: bot and sysop

APIs อื่น ๆ

หากคุณไม่พบสิ่งที่คุณกำลังมองหาในเอกสารคู่มือเกี่ยวกับ API นี้ มี APIs อื่น ๆ อีกมากมายที่เกี่ยวข้องกับโครงการวิกิมีเดีย (Wikimedia) สำหรับ REST API (Representational State Transfer API) ที่มาพร้อมกับ MediaWiki 1.35 และใหม่กว่า โปรดดูที่ API:REST API

API	Availability	URL base	Example
MediaWiki Action API	Included with MediaWiki Enabled on Wikimedia projects	/api.php	https://en.wikipedia.org/w/api.php?action=query&prop=info&titles=Earth
MediaWiki REST API	Included with MediaWiki 1.35+ Enabled on Wikimedia projects	/rest.php	https://en.wikipedia.org/w/rest.php/v1/page/Earth
Wikimedia REST API	Not included with MediaWiki Available for Wikimedia projects only	/api/rest	https://en.wikipedia.org/api/rest_v1/page/title/Earth
For commercial-scale APIs for Wikimedia projects, see Wikimedia Enterprise