MediaWiki API ヘルプ
このページは自動生成された MediaWiki API の説明文書ページです。
説明文書と例: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
メイン モジュール
- ソース: MediaWiki
- ライセンス: GPL-2.0-or-later
状態: MediaWiki APIは、サポートおよび更新が恒常的に続けられている、安定した多機能インターフェースです。時折大きな仕様変更が適用されることもありますが、the mediawiki-api-announce メーリングリストを購読すると適時にアップデート通知を受け取ることができます。
リクエストエラー: 非適合形式でAPIにリクエストに送られた場合、"MediaWiki-API-Error"のキーを含むHTTPヘッダーが返され、レスポンスのヘッダー値とエラーコード値が同値になります。詳細は、API:エラーと警告をご覧ください。
テスト: APIサンドボックスを使用すると、容易にAPIリクエストのテストが可能です。
- action
実行する操作。
- abusefiltercheckmatch
- 不正利用フィルターが変数のセット、編集、またはログに記録された不正利用フィルターイベントと一致するかどうかを確認します。
- abusefilterchecksyntax
- 不正利用フィルターの構文を確認します。
- abusefilterevalexpression
- 不正利用フィルターの式を評価します。
- abusefilterunblockautopromote
- 不正利用フィルターの結果により、利用者が権限を自動で取得することをできないようにします。
- abuselogprivatedetails
- 不正利用記録エントリの個人情報を表示します。
- acquiretempusername
- Acquire a temporary user username and stash it in the current session, if temp account creation is enabled and the current user is logged out. If a name has already been stashed, returns the same name.
- antispoof
- 利用者名が AntiSpoof の正規化チェックに反しているかどうかチェックする。
- block
- 利用者をブロックします。
- 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
- 現在の利用者の認証データを変更します。
- changecontentmodel
- ページのコンテンツモデルを変更します。
- checktoken
- action=query&meta=tokens のトークンの妥当性を確認します。
- cirrus-config-dump
- CirrusSearch の設定をダンプします。
- cirrus-mapping-dump
- このウィキの CirrusSearch のマッピングをダンプします。
- cirrus-profiles-dump
- このウィキの CirrusSearch のプロファイルをダンプします。
- cirrus-settings-dump
- このウィキの CirrusSearch の設定をダンプします。
- clearhasmsg
- 現在の利用者の
hasmsg
フラグを消去します。 - clientlogin
- インタラクティブフローを使用してウィキにログインします。
- communityconfigurationedit
- Change the content of a configuration provider in Community configuration
- compare
- 2つの版間の差分を取得します。
- createaccount
- 新しい利用者アカウントを作成します。
- createlocalaccount
- Forcibly create a local account. The central account must exist.
- cxdelete
- コンテンツ翻訳拡張を利用して作成した草稿の翻訳を削除。
- cxsuggestionlist
- 候補一覧を管理。一覧から候補の追加や削除をする。
- cxtoken
- cxserverの認証のためのJWTトークンを取得する。
- delete
- ページを削除します。
- deleteglobalaccount
- グローバル利用者を削除します。
- discussiontoolsedit
- 議論ページにメッセージを投稿する。
- discussiontoolsfindcomment
- Find a comment by its ID or name.
- discussiontoolsgetsubscriptions
- 指定されたトピックの購読状態を取得します。
- discussiontoolssubscribe
- トピックに関する通知を受け取るために、購読(または購読解除)します。
- discussiontoolsthank
- Send a public thank-you notification for a comment.
- echocreateevent
- Manually trigger a notification to a user
- echomarkread
- 現在の利用者への通知を既読にする。
- echomarkseen
- Mark notifications as seen for the current user.
- echomute
- Mute or unmute notifications from certain users or pages.
- edit
- ページを作成、編集します。
- editmassmessagelist
- メッセージ一斉送信リストの編集
- emailuser
- 利用者にメールを送信します。
- expandtemplates
- ウィキテキストに含まれるすべてのテンプレートを展開します。
- featuredfeed
- Returns a featured content feed.
- feedcontributions
- 利用者の投稿記録フィードを返します。
- feedrecentchanges
- 最近の更新フィードを返します。
- feedwatchlist
- ウォッチリストのフィードを返します。
- filerevert
- ファイルを古い版に差し戻します。
- globalblock
- 利用者をグローバルでブロックまたはブロック解除する。
- globalpreferenceoverrides
- Change local overrides for global preferences for the current user.
- globalpreferences
- 現在の利用者のグローバル設定を変更します。
- globaluserrights
- 利用者にグローバルグループを追加したり、利用者からグローバルグループを除去します。
- growthmanagementorlist
- Manage information in the structured mentor list (usually stored in MediaWiki:GrowthMentors.json). This module can be used by both current and future mentors (to add themselves or change their details) and administrators (for all users).
- growthmentordashboardupdatedata
- Schedule an extraordinary update of the mentee overview module in the mentor dashboard. You can only schedule one update per two hours for performance reasons.
- growthsetmenteestatus
- Set mentee's status (allows mentees to enable/disable mentorship module, or to opt-out entirely, which deletes the mentee/mentor relationship)
- growthsetmentor
- 利用者の指導者を設定。変更は公に記録されます。
- growthstarmentee
- 表示された利用者を指導するなら星マークを付け、しないなら外します (非公開で保存されログ記録は残りません)
- help
- 指定したモジュールのヘルプを表示します。
- homepagequestionstore
- ホームページモジュールを経由して投稿されるフォーマット済みの質問を取得する
- imagerotate
- このモジュールは無効化されています。
- import
- 別のウィキまたはXMLファイルからページをインポートする。
- jsonconfig
- JsonConfig サブシステムに直接アクセスできるようにします。
- languagesearch
- 任意のスクリプトで言語名を検索。
- linkaccount
- Link an account from a third-party provider to the current user.
- login
- ログインして認証クッキーを取得します。
- logout
- ログアウトしてセッションデータを消去します。
- managetags
- Perform management tasks relating to change tags.
- massmessage
- Send a message to a list of pages.
- mergehistory
- ページの履歴を統合する。
- move
- ページを移動します。
- opensearch
- OpenSearch プロトコルを使用してウィキ内を検索します。
- options
- 現在の利用者の設定を変更します。
- paraminfo
- API モジュールに関する情報を取得します。
- parse
- Parses content and returns parser output.
- patrol
- ページまたは版を巡回済みにする。
- protect
- ページの保護レベルを変更します。
- purge
- 指定されたページのキャッシュを破棄します。
- query
- MediaWikiからデータを取得します。
- removeauthenticationdata
- Remove authentication data for the current user.
- resetpassword
- 利用者にパスワードをリセットするメールを送信します。
- revisiondelete
- 版の削除および復元を行います。
- rollback
- ページの最後の編集を取り消す。
- rsd
- Export an RSD (Really Simple Discovery) schema.
- setglobalaccountstatus
- Hide or lock (or unhide or unlock) a global user account.
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- ページの言語を変更します。
- shortenurl
- 長いURLを短いURLに短縮します。
- sitematrix
- Get Wikimedia sites list.
- spamblacklist
- 1件以上の URL についてスパムブロックリストに登録されているか検証します。
- streamconfigs
- Exposes event stream config. Returns only format=json with formatversion=2.
- strikevote
- Allows admins to strike or unstrike a vote.
- sxdelete
- Delete the draft section translation and its parallel corpora from database.
- tag
- 個々の版または記録項目に対しタグの追加または削除を行います。
- templatedata
- TemplateData 拡張機能によって保存されたデータを取得します。
- thank
- 編集者に感謝の通知を送信する。
- titleblacklist
- TitleBllacklist に対してページ名、ファイル名、利用者名を検証します。
- torblock
- Check if an IP address is blocked as a Tor exit node.
- 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.
- upload
- Upload a file, or get the status of pending uploads.
- userrights
- 利用者の所属グループを変更します。
- validatepassword
- Validate a password against the wiki's password policies.
- watch
- 現在の利用者のウォッチリストにページを追加/除去します。
- webapp-manifest
- Returns a webapp manifest.
- webauthn
- API Module to communicate between server and client during registration/authentication process.
- wikilove
- 別の利用者にウィキラブを贈ります。
- bouncehandler
- 内部で使用。 Receive a bounce email and process it to handle the failing recipient.
- categorytree
- 内部で使用。 カテゴリツリー拡張機能の内部モジュール。
- cirrus-check-sanity
- 内部で使用。 Reports on the correctness of a range of page ids in the search index
- collection
- 内部で使用。 API module for performing various operations on a wiki user's collection.
- 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.
- cxcheckunreviewed
- 内部で使用。 Check if any fast, unreviewed translation has been published recently for the current user.
- cxpublish
- 内部で使用。 コンテンツ翻訳機能を用いて作成されたページを保存
- cxpublishsection
- 内部で使用。 コンテンツ翻訳拡張機能の節単位翻訳を使って、セクションを作成し保存。
- cxsave
- 内部で使用。 このモジュールは帯域を節約しパラレルなコーポラを集積するため、翻訳の草稿を節単位で保存できます。
- cxsplit
- 内部で使用。 Create and save a section translation to database, for every translated section of the given article translation
- discussiontoolscompare
- 内部で使用。 Get information about comment changes between two page revisions.
- discussiontoolspageinfo
- 内部で使用。 議論用ツールの初期化に必要なメタデータを返します。
- discussiontoolspreview
- 内部で使用。 議論ページのメッセージをプレビューします。
- echopushsubscriptions
- 内部で使用。 Manage push subscriptions for the current user.
- editcheckreferenceurl
- 内部で使用。 Check the status of a URL for use as a reference.
- fancycaptchareload
- 内部で使用。 新しい FancyCaptcha を取得します。
- growthinvalidateimagerecommendation
- 内部で使用。 Invalidate an image recommendation.
- growthinvalidatepersonalizedpraisesuggestion
- 内部で使用。 Invalidates a suggestion of a praiseworthy mentee in the Personalized praise module on the Mentor dashboard
- helppanelquestionposter
- 内部で使用。 この利用者がヘルプパネル経由で投稿した質問を担当します。
- jsondata
- 内部で使用。 Retrieve localized JSON data.
- oathvalidate
- 内部で使用。 二要素認証 (OATH) トークンを検証する。
- parser-migration
- 内部で使用。 Parse a page with two different parser configurations.
- readinglists
- 内部で使用。 Reading list write operations.
- sanitize-mapdata
- 内部で使用。 Kartographer 拡張機能用にデータ検証を実施
- scribunto-console
- 内部で使用。 Internal module for servicing XHR requests from the Scribunto console.
- securepollauth
- 内部で使用。 Allows a remote wiki to authenticate users before granting access to vote in the election.
- stashedit
- 内部で使用。 Prepare an edit in shared cache.
- sxsave
- 内部で使用。 Save the draft section translation and store the parallel corpora
- timedtext
- 内部で使用。 Provides timed text content for usage by <track> elements
- ulslocalization
- 内部で使用。 ULSの当該言語訳を取得。
- ulssetlang
- 内部で使用。 Update user's preferred interface language.
- visualeditor
- 内部で使用。 Returns HTML5 for a page from the Parsoid service.
- visualeditoredit
- 内部で使用。 HTML5ページを MediaWiki として保存する (Parsoidサービスを利用してウィキテキストに変換されます)
- wikimediaeventsblockededit
- 内部で使用。 Log information about blocked edit attempts
- 値 (次の値のいずれか1つ): abusefiltercheckmatch、abusefilterchecksyntax、abusefilterevalexpression、abusefilterunblockautopromote、abuselogprivatedetails、acquiretempusername、antispoof、block、centralauthtoken、centralnoticecdncacheupdatebanner、centralnoticechoicedata、centralnoticequerycampaign、changeauthenticationdata、changecontentmodel、checktoken、cirrus-config-dump、cirrus-mapping-dump、cirrus-profiles-dump、cirrus-settings-dump、clearhasmsg、clientlogin、communityconfigurationedit、compare、createaccount、createlocalaccount、cxdelete、cxsuggestionlist、cxtoken、delete、deleteglobalaccount、discussiontoolsedit、discussiontoolsfindcomment、discussiontoolsgetsubscriptions、discussiontoolssubscribe、discussiontoolsthank、echocreateevent、echomarkread、echomarkseen、echomute、edit、editmassmessagelist、emailuser、expandtemplates、featuredfeed、feedcontributions、feedrecentchanges、feedwatchlist、filerevert、globalblock、globalpreferenceoverrides、globalpreferences、globaluserrights、growthmanagementorlist、growthmentordashboardupdatedata、growthsetmenteestatus、growthsetmentor、growthstarmentee、help、homepagequestionstore、imagerotate、import、jsonconfig、languagesearch、linkaccount、login、logout、managetags、massmessage、mergehistory、move、opensearch、options、paraminfo、parse、patrol、protect、purge、query、removeauthenticationdata、resetpassword、revisiondelete、rollback、rsd、setglobalaccountstatus、setnotificationtimestamp、setpagelanguage、shortenurl、sitematrix、spamblacklist、streamconfigs、strikevote、sxdelete、tag、templatedata、thank、titleblacklist、torblock、transcodereset、unblock、undelete、unlinkaccount、upload、userrights、validatepassword、watch、webapp-manifest、webauthn、wikilove、bouncehandler、categorytree、cirrus-check-sanity、collection、cspreport、cxcheckunreviewed、cxpublish、cxpublishsection、cxsave、cxsplit、discussiontoolscompare、discussiontoolspageinfo、discussiontoolspreview、echopushsubscriptions、editcheckreferenceurl、fancycaptchareload、growthinvalidateimagerecommendation、growthinvalidatepersonalizedpraisesuggestion、helppanelquestionposter、jsondata、oathvalidate、parser-migration、readinglists、sanitize-mapdata、scribunto-console、securepollauth、stashedit、sxsave、timedtext、ulslocalization、ulssetlang、visualeditor、visualeditoredit、wikimediaeventsblockededit
- 既定: help
- format
出力フォーマット。
- 値 (次の値のいずれか1つ): json、jsonfm、none、php、phpfm、rawfm、xml、xmlfm
- 既定: 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.- 型: 整数
- smaxage
s-maxage
のHTTPキャッシュコントロールヘッダーをこの秒数に指定します。エラーはキャッシュされません。- 型: 整数
- 値の下限は必ず0以上です。
- 既定: 0
- maxage
max-age
のHTTPキャッシュコントロールヘッダーをこの秒数に指定します。エラーはキャッシュされません。- 型: 整数
- 値の下限は必ず0以上です。
- 既定: 0
- assert
user に設定した場合は利用者がログインしていること(臨時利用者としてログインしている場合も含む)を、 anon に設定した場合はログインしていないことを、bot の場合はボット利用者権限があることを検証します。
- 値 (次の値のいずれか1つ): anon、bot、user
- assertuser
現在の利用者が指定された利用者であることを確認します。
- 型: 利用者名 および 臨時利用者のいずれかを使った利用者
- requestid
任意の値を指定でき、その値が結果に含められます。リクエストを識別するために使用できます。
- servedby
リクエストを処理したホスト名を結果に含めます。
- 型: 真偽値 (詳細)
- curtimestamp
現在のタイムスタンプを結果に含めます。
- 型: 真偽値 (詳細)
- responselanginfo
結果にuselangとerrorlangに使用される言語を含めます。
- 型: 真偽値 (詳細)
- 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-two.iwiki.icu 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 allowed, theAccess-Control-Allow-Origin
andAccess-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, butAccess-Control-Allow-Credentials
will befalse
and all user-specific data will be restricted.- uselang
メッセージの翻訳に使用する言語です。action=query&meta=siteinfo&siprop=languages は言語コードの一覧を返します。user を指定することで現在の利用者の個人設定の言語を、content を指定することでこのウィキの本文の言語を使用することもできます。
- 既定: user
- variant
言語変種。基本言語が言語変種変換をサポートしている場合のみ機能します。
- errorformat
警告およびエラーテキストの出力に使用する形式
- plaintext
- HTMLタグを除去し、実体を置換したウィキテキスト。
- wikitext
- パースされていないウィキテキスト。
- html
- HTML
- raw
- メッセージキーとパラメーター。
- none
- テキスト出力なし、エラーコードのみ。
- bc
- MediaWiki 1.29より前に使われていた形式。 errorlang および errorsuselocal は無視されます。
- 値 (次の値のいずれか1つ): bc、html、none、plaintext、raw、wikitext
- 既定: bc
- errorlang
警告およびエラーで使用する言語。 action=query&meta=siteinfo&siprop=languages は言語コードの一覧を返します。 content を指定するとこのウィキのコンテンツ言語、uselang を指定すると uselang パラメーターと同じ値を使用します。
- 既定: uselang
- errorsuselocal
指定された場合、エラーテキストはMediaWiki名前空間からローカルにカスタマイズされたメッセージを使用します。
- 型: 真偽値 (詳細)
- 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).
- メイン モジュールのヘルプ
- api.php?action=help [サンドボックスで開く]
- すべてのヘルプを1つのページに
- api.php?action=help&recursivesubmodules=1 [サンドボックスで開く]
データ型
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.
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.
Some parameter types in API requests need further explanation:
- boolean
真偽値のパラメーターはHTMLのチェックボックスのように機能します: パラメーターが指定されていれば、値に関わらず、真であると推定します。偽の値については、パタメーター自体を省略してください。
- expiry
期間は、相対値(例えば、5 months や 2 weeks)または絶対値(例えば、2014-09-18T12:34:56Z)のどちらかで指定します。期間を定めない場合は、infinite, indefinite, infinity または never を用います。
- timestamp
Timestamps may be specified in several formats, see the Timestamp library input formats documented on mediawiki.org for details. ISO 8601 date and time is recommended: 2001-01-15T14:56:00Z. Additionally, the string now may be used to specify the current timestamp.
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 の開発者:
- Yuri Astrakhan (作成者、2006年9月-2007年9月の主任開発者)
- Roan Kattouw (2007年9月-2009年の主任開発者)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsch (2013年-2020年の主任開発者)
コメント、提案、質問は [email protected] にお送りください。 バグはこちらへご報告ください: https://phabricator.wikimedia.org/