MediaWiki API ヘルプ

このページは自動生成された MediaWiki API の説明文書ページです。

説明文書と例: https://www.mediawiki.org/wiki/API

メイン モジュール

状態: MediaWiki APIは、積極的にサポートされ、改善された成熟した安定したインターフェースです。避けようとはしていますが、時には壊れた変更が加えられるかもしれません。アップデートの通知を受け取るには、the mediawiki-api-announce メーリングリストに参加してください。

誤ったリクエスト: 誤ったリクエストが API に送られた場合、"MediaWiki-API-Error" HTTP ヘッダーが送信され、そのヘッダーの値と送り返されるエラーコードは同じ値にセットされます。より詳しい情報は API: Errors and warnings を参照してください。

パラメーター:
action

実行する操作です。

adddomainalias
Add a domain alias to wiki
annotatewikinotspam
Wikiをスパムでないと注記
block
利用者をブロックします。
categorytree
カテゴリツリー拡張機能の内部モジュール。
changeauthenticationdata
現在の利用者の認証データを変更します。
checktoken
action=query&meta=tokens のトークンの妥当性を確認します。
checkwikistatus
新しいWikiの作成プロセスが完了したか確認し、各段階および全プロセスのステータスを返します。
clearhasmsg
現在の利用者の hasmsg フラグを消去します。
clearwikiconfigcache
Wikiの設定キャッシュをクリアします。
clientlogin
インタラクティブフローを使用してウィキにログインします。
compare
2つの版間の差分を取得します。
createaccount
新しい利用者アカウントを作成します。
createnewwiki
新しいWikiの作成をはじめる
createwikiconfigvariabledefinition
設定変数を作成します。
cspreport
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.
delete
ページを削除します。
details
edit
ページを作成、編集します。
emailuser
利用者にメールを送信します。
embedvideo
Get generated video embed code for given parameters.
expandtemplates
ウィキテキストに含まれるすべてのテンプレートを展開します。
feedcontributions
利用者の投稿記録フィードを返します。
feedrecentchanges
最近の更新フィードを返します。
feedwatchlist
ウォッチリストのフィードを返します。
filerevert
ファイルを古い版に差し戻します。
gettheme
help
指定したモジュールのヘルプを表示します。
imagerotate
1つ以上の画像を回転させます。
imageserving
This module is used to return one image URL for the specified article given either the article ID or article title (with prefix if applicable).
import
他のWikiまたはXMLファイルからページを取り込む。
infobox
This module provides infobox parser
linkaccount
Link an account from a third-party provider to the current user.
linksuggest
Suggest link to editors on edit view
listusersnamesearch
listuserssearchuser
listwikiswithextension
拡張機能が有効になっているWikiのリストを取得します。
listwikiswithvariable
変数が指定のステータスであるWikiのリストを取得します。
login
ログインして認証クッキーを取得します。
logout
ログアウトしてセッションデータを消去します。
lookupcontribs
Lookup user contributions
managetags
Perform management tasks relating to change tags.
markwikiclosed
指定のWikiを閉鎖済み(非公開)にします。
markwikiopen
指定のWikiを開設済み(一般公開)にします。
markwikiprotected
閉鎖されないようWikiを保護済みにします。
masseditwikis
Wikiのリストの設定変数を編集します。
mergehistory
ページの履歴を統合する。
mobileview
Returns data needed for mobile views.
modifydomainalias
Modify a domain alias to wiki
move
ページを移動します。
multidelete
multifindcharacter
notifications
Retrieve notifications for the current user.
opensearch
OpenSearch プロトコルを使用してWiki内を検索します。
options
Change preferences of the current user.
paraminfo
API モジュールに関する情報を取得します。
parse
Parses content and returns parser output.
parsoid-batch
Parsoid用バッチAPI
patrol
ページまたは版を巡回済みにする。
protect
ページの保護レベルを変更します。
purge
指定されたページのキャッシュを破棄します。
query
MediaWikiからデータを取得します。
removeauthenticationdata
Remove authentication data for the current user.
removedomainalias
Remove a domain alias to wiki
removephalanxblock
removewikiconfigvariable
Wikiの設定変数を削除します。
reopenwiki
resetpassword
Send a password reset email to a user.
revisiondelete
版の削除および復元を行います。
rollback
ページの最後の編集を取り消す。
rsd
Export an RSD (Really Simple Discovery) schema.
savetheme
savewikiconfigvariable
Wikiの設定変数を指定します。
schedulesearchindexupdate
scribunto-console
Internal module for servicing XHR requests from the Scribunto console.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
ページの言語を変更します。
stashedit
Prepare an edit in shared cache.
suggestwiki
suggestwikis
ドメインに検索語句が含まれているWikiのリストを取得します。
tag
個々の版または記録項目に対しタグの追加または削除を行います。
tagsreport
templatedata
TemplateData拡張機能の代替機能を提供するAPI実装。トランスクルージョンの該当するテンプレート・パラメータを取得するビジュアルエディタによって使用されます
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.
unblock
利用者のブロックを解除します。
undelete
削除されたページの版を復元します。
unlinkaccount
Remove a linked third-party account from the current user.
updateHubs
Wikiのカテゴリとジャンルを更新
updateprimarydomain
Update primary domain of a wiki
updatewikiconfigvariabledefinition
既存の設定変数のプロパティを更新します。
upload
Upload a file, or get the status of pending uploads.
uploadimage
userrights
利用者の所属グループを変更します。
validatepassword
Validate a password against the wiki's password policies.
variableinfo
指定の設定変数に関する詳細情報を取得します。
variableupdate
変数情報を更新
visualeditor
Returns HTML5 for a page from the Parsoid service.
visualeditoredit
Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
watch
現在の利用者のウォッチリストにページを追加/除去します。
webapp-manifest
Returns a webapp manifest.
tokens
廃止予定です。 Get tokens for data-modifying actions.
値 (次の値のいずれか1つ): adddomainaliasannotatewikinotspamblockcategorytreechangeauthenticationdatachecktokencheckwikistatusclearhasmsgclearwikiconfigcacheclientlogincomparecreateaccountcreatenewwikicreatewikiconfigvariabledefinitioncspreportdeletedetailseditemailuserembedvideoexpandtemplatesfeedcontributionsfeedrecentchangesfeedwatchlistfilerevertgetthemehelpimagerotateimageservingimportinfoboxlinkaccountlinksuggestlistusersnamesearchlistuserssearchuserlistwikiswithextensionlistwikiswithvariableloginlogoutlookupcontribsmanagetagsmarkwikiclosedmarkwikiopenmarkwikiprotectedmasseditwikismergehistorymobileviewmodifydomainaliasmovemultideletemultifindcharacternotificationsopensearchoptionsparaminfoparseparsoid-batchpatrolprotectpurgequeryremoveauthenticationdataremovedomainaliasremovephalanxblockremovewikiconfigvariablereopenwikiresetpasswordrevisiondeleterollbackrsdsavethemesavewikiconfigvariableschedulesearchindexupdatescribunto-consolesetnotificationtimestampsetpagelanguagestasheditsuggestwikisuggestwikistagtagsreporttemplatedatatitleblacklisttranscoderesetunblockundeleteunlinkaccountupdateHubsupdateprimarydomainupdatewikiconfigvariabledefinitionuploaduploadimageuserrightsvalidatepasswordvariableinfovariableupdatevisualeditorvisualeditoreditwatchwebapp-manifesttokens
既定値: help
format

出力する形式です。

json
データを JSON 形式で出力します。
jsonfm
データを JSON 形式 (HTML に埋め込んだ形式) で出力します。
none
何も出力しません。
php
データを PHP のシリアル化した形式で出力します。
phpfm
データを PHP のシリアル化した形式 (HTML に埋め込んだ形式) で出力します。
rawfm
データをデバッグ要素付きで JSON 形式 (HTML に埋め込んだ形式) で出力します。
xml
データを XML 形式で出力します。
xmlfm
データを XML 形式 (HTML に埋め込んだ形式) で出力します。
値 (次の値のいずれか1つ): jsonjsonfmnonephpphpfmrawfmxmlxmlfm
既定値: 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

s-maxage HTTP キャッシュ コントロール ヘッダー に、この秒数を設定します。エラーがキャッシュされることはありません。

Type: integer
既定値: 0
maxage

max-age HTTP キャッシュ コントロール ヘッダー に、この秒数を設定します。エラーがキャッシュされることはありません。

Type: integer
既定値: 0
assert

user を設定した場合は利用者がログイン済みかどうかを、bot を指定した場合はボット権限があるかどうかを、それぞれ検証します。

値 (次の値のいずれか1つ): userbot
assertuser

現在のユーザーが指定されたユーザーであることを確認します。

Type: user name
requestid

任意の値を指定でき、その値が結果に含められます。リクエストを識別するために使用できます。

servedby

リクエストを処理したホスト名を結果に含めます。

Type: boolean (details)
curtimestamp

現在のタイムスタンプを結果に含めます。

Type: boolean (details)
responselanginfo

結果にuselangerrorlangに使用される言語を含めます。

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 whitelisted, 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

メッセージの翻訳に使用する言語です。action=query&meta=siteinfosiprop=languages を付けると言語コードの一覧を返します。user を指定することで現在の利用者の個人設定の言語を、content を指定することでこのウィキの本文の言語を使用することもできます。

既定値: user
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.
値 (次の値のいずれか1つ): plaintextwikitexthtmlrawnonebc
既定値: 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.

既定値: uselang
errorsuselocal

指定された場合、エラーテキストはMediaWiki名前空間からローカルにカスタマイズされたメッセージを使用します。

Type: boolean (details)
例:
メイン モジュールのヘルプ
api.php?action=help [サンドボックスで開く]
すべてのヘルプを1つのページに
api.php?action=help&recursivesubmodules=1 [サンドボックスで開く]
権限:
writeapi
書き込み API を使用
権限を持つグループ: all、user および bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
権限を持つグループ: bot、sysop、staff、helper、soap、wiki-representative および wiki-specialist

データ型

Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as edits with MD5 checks) to fail.

Some parameter types in API requests need further explanation:

boolean
Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.
timestamp
Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
  • ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
  • ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
  • MediaWiki format, 20010115145600
  • Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
  • EXIF format, 2001:01:15 14:56:00
  • RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
  • RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
  • C ctime format, Mon Jan 15 14:56:00 2001
  • Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
  • The string now
alternative multiple-value separator
Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.

Templated parameters

Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter fruits to specify which fruits are being requested and a templated parameter {fruit}-quantity to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.

クレジット

API の開発者:

  • Roan Kattouw (2007年9月-2009年の主任開発者)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (作成者、2006年9月-2007年9月の主任開発者)
  • Brad Jorsch (2013年-現在の主任開発者)

コメント、提案、質問は mediawiki-api@lists.wikimedia.org にお送りください。 バグはこちらへご報告ください: https://phabricator.wikimedia.org/