API:Extensions/ja

このドキュメントでは、MediaWiki 1.30またはそれ以降での、APIモジュールの作成を扱います.

モジュールの作成と登録
すべてのAPIはのサブクラスですが、派生したベースクラスを使用するタイプのモジュールもあります. 登録の方法もまた、モジュールのタイプに依存します.


 * actionモジュール
 * メインの パラメーターに値を送るモジュールは必ずをサブクラス化します. 登録には キーを用いて、 に記載すること.


 * 書式のモジュール
 * メインの パラメーターに値を送るモジュールは必ずをサブクラス化します. 登録には キーを用いて に記載のこと.  拡張機能に書式モジュールが必要な場合は非常にまれです.


 * クエリの下位モジュール
 * や または の値、 の属性値を与えるモジュールは、必ず（ジェネレータとして使用が不可な場合）か（同じく使用可能な場合）をサブクラス化します.  、 もしくは のキーを用いて、必ず に記載します.

どの場合も、登録キーの値はモジュール名を備えたオブジェクト (つまり属性の値) をキーに用い、クラス名はその値とします. モジュールの登録は条件付で (actionとformatモジュールには) ApiMain::moduleManagerと (クエリの下位モジュールには) ApiQuery::moduleManagerを用います.

接頭辞
ご利用のAPIモジュールのコンストラクタ関数では、 を呼び出すときにオプションとしてモジュールのパラメーターに接頭辞を指定できます. (モジュールに関する説明文書を作成すると、この接頭辞が存在する場合にはモジュールの見出しにカッコ入りで表示されます. ) ご利用のモジュールがクエリ用下位モジュールである場合、クライアントに正しい動作をさせるため接頭辞が必要です. 接頭辞がないと、それぞれ固有のパラメーターを要する複数の下位モジュールを一度に作動させようとしてしまいます. action及びformatモジュールについては、接頭辞の付与はオプションです.

パラメーター
大半のモジュールにはパラメーターが必要です. その設定にはを実行します. 戻り値は、キーに（接頭辞のない）パラメーター名を取り、値はパラメータのスカラー既定値か、もしくはが規定する 定数を用いてパラメータのプロパティを定義する配列のいずれかとなります.

サンプルには構文ならびに比較的よく見かける 定数を示します.

パラメータの説明文書はMediaWikiのi18nの仕組み（地域化）に従います. 詳細は#説明文書節を参照してください.

実行と出力
モジュールを実行するコードは方式を採用します. 一般的にこのコードはを使用して入力パラメータを取得、出力を追加するためにはを使用してオブジェクトを獲得します.

クエリ属性の下位モジュールにはを用いて、操作するページ群のセットにアクセスします.

ジェネレータとして使用可能なクエリ下位モジュールの場合も、の実行が必要で、生成したページ名を入力するをわたします. この事例では一般的に、 を使用するべきではありません.

キャッシュ
APIの反応は既定ではキャッシュの対象外です ('Cache-Control: private')! actionモジュールにおいてを呼び出すとキャッシュの実行を承認できます. その場合にも、クライアントが もしくは パラメータを容認してからでないとキャッシュできません. を呼ぶと強制キャッシュも可能です.

クエリモジュールにおいては、これらのモジュールの呼び出しは禁止です. その代わりに、を実行するとキャッシュできます.

いずれの場合にも、個人特定情報をさらさないようにご注意ください.

トークンの処理
If your action module changes the wiki in any way, it should require a token of some kind. To have this handled automatically, implement the  method, returning the token that your module requires (probably the   edit token). The API base code will then automatically validate the token that clients provide in API requests in a  parameter.

Master database access
If your module accesses the master database, it should implement the  method to return.

Returning errors
includes several methods for performing various checks, for example,
 * If you need to assert that exactly one of a set of parameters was supplied, use.
 * If you need to assert that at most one of a set of parameters was supplied, use.
 * If you need to assert that at least one of a set of parameters was supplied, use.
 * If you need to assert that the user has certain rights, use.
 * If you need to assert that the user can take an action on a particular page, use.
 * If the user is blocked (and that matters to your module), pass the  object to.

But you will often run into cases where you need to raise an error of your own. The usual way to do that is to call, although if you have a  with the error information you could pass it to  instead.

If you need to issue a warning rather than an error, use, or if it's a deprecation warning.

説明文書
The API is documented using MediaWiki's i18n mechanism. Needed messages generally have default names based on the module's "path". For action and format modules, the path is the same as the module's name used during registration. For query submodules, it's the name prefixed with "query+".

Every module will need a  message, which should be a one-line description of the module. If additional help text is needed,  may be created as well. Each parameter will need a  message, and parameters using   will also need a   for each value.

More details on API documentation are available at.

Extensions may also maintain extra API documentation on WikiMedia.org. This should be located on the extension's main page or, if more space is required, on pages named  or subpages thereof (e.g. CentralAuth, MassMessage, or StructuredDiscussions). The API namespace is reserved for the API of MediaWiki core.

コアモジュールの拡張
MediaWiki 1.14以降、以下のフックを使うことで、コアモジュールの機能を拡張することができます：


 * モジュールのパラメータ一覧を追加もしくは修正するにはAPIGetAllowedParams
 * モジュールのパラメータに関する説明の追加もしくは修正をするにはAPIGetParamDescription
 * モジュールの実装後 (ただし結果出力の前) の処理はAPIAfterExecute
 * 、 及び モジュールに対しては APIQueryAfterExecuteを使用します
 * モジュールをジェネレータモードで実行したい場合は代わりにAPIQueryGeneratorAfterExecuteを使用します

API機能を備えた拡張機能の一覧
API機能を備えたり拡張したりする拡張機能の例はAPI extensionsをご参照ください.

拡張機能の試験

 * [/api.php api.php]を開き、ご利用のモジュールに対して作成されたヘルプ節もしくはクエリの下位モジュール節へ移動します. ご利用の拡張機能のヘルプ情報が正しいかどうか、確認する必要があります.
 * で提供したサンプルURL群が「例」に表示されるので、クリックします.
 * クエリ文字列中のURLパラメータを除去したり文字列を一部削除して、拡張機能の反応を試します.
 * Special:ApiSandboxを開き、ご利用のAPIをインタラクティブに試用します.
 * ご利用の拡張機能に関するその他の情報は、次のリンク先を開いて確認します.