MediaWiki API ヘルプ
このページは自動生成された MediaWiki API の説明文書ページです。
説明文書と例: https://www.mediawiki.org/wiki/API
メイン モジュール
- Source: MediaWiki
- License: GPL-2.0+
Status: All features shown on this page should be working, but the API is still in active development, and may change at any time. 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.
- action
実行する操作です。
- 値 (次の値のいずれか1つ): block、checktoken、clearhasmsg、compare、createaccount、delete、edit、emailuser、expandtemplates、feedcontributions、feedrecentchanges、feedwatchlist、filerevert、help、imagerotate、import、login、logout、managetags、move、opensearch、options、paraminfo、parse、patrol、protect、purge、query、revisiondelete、rollback、rsd、setnotificationtimestamp、spamblacklist、stashedit、tag、titleblacklist、tokens、unblock、undelete、upload、userrights、watch
- 既定値: help
- format
出力する形式です。
- 値 (次の値のいずれか1つ): dbg、dbgfm、json、jsonfm、none、php、phpfm、rawfm、txt、txtfm、xml、xmlfm、yaml、yamlfm
- 既定値: 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つ): user、bot
- requestid
任意の値を指定でき、その値が結果に含められます。リクエストを識別するために使用できます。
- servedby
リクエストを処理したホスト名を結果に含めます。
- Type: boolean (details)
- curtimestamp
現在のタイムスタンプを結果に含めます。
- 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). 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 theOrigin
header, a 403 response will be returned. If this parameter matches theOrigin
header and the origin is whitelisted, anAccess-Control-Allow-Origin
header will be set.- uselang
メッセージの翻訳に使用する言語です。コードの一覧は action=query&meta=siteinfo に siprop=languages を付けることで取得できます。user を指定することで現在の利用者の個人設定の言語を、content を指定することでこのウィキの本文の言語を使用することもできます。
- 既定値: user
- メイン モジュールのヘルプ
- api.php?action=help
- すべてのヘルプを1つのページに
- api.php?action=help&recursivesubmodules=1
Data types
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
クレジット
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/