API:Extensions/ru

В этом документе описывается создание модуля API в расширении для MediaWiki 1.30 или более поздних версий.

Создание и регистрация модуля
Все модули API являются подклассами, но некоторые типы модулей наследуют от производного класса. Также от типа модуля зависит метод регистрации.


 * модули действий (action)
 * Модули, предоставляющие значение для основного параметра, должны быть подклассами . Их нужно зарегистрировать в  , используя ключ.


 * модули форматов (format)
 * Модули, предоставляющие значение для основного параметра, должны быть подклассами . Их нужно зарегистрировать в  , используя ключ  . Необходимость модуля формата в расширении встречается очень редко.


 * подмодули запросов (query)
 * Модули, предоставляющие значения для параметров,   или   к действию  , должны быть подклассами  (если модули не могут использоваться в качестве генераторов) или  (если модули могут использоваться в качестве генераторов). Их нужно зарегистрировать в   используя ключ  ,   или.

Во всех случаях значение ключа регистрации — объект, где ключ — название модуля, а значение — название класса. Модули также могут быть зарегистрированы условно, если использовать хуки ApiMain::moduleManager (для модулей действий и форматов) и ApiQuery::moduleManager (для подмодулей запросов).

Префикс
Когда вы вызываете  в конструкторе вашего модуля API, вы можете также указать префикс для параметров вашего модуля. (В генерируемой документации модуля этот префикс, если он присутствует, будет указан в круглых скобках в заголовке модуля.) Если ваш модуль — подмодуль запроса (query), префикс обязателен, так как клиент в одном запросе может вызвать несколько подмодулей, каждый со своими параметрами. В случае с модулями действия или форматирования префикс необязателен.

Параметры
Большинство модулей требуют параметры. Они определяются путём реализации. Значение, возвращаемое этим методом, — ассоциативный массив, в котором ключи — названия параметров (без префикса), а значения — или скалярные значения параметра по умолчанию, или массивы, определяющие свойства параметра, используя определённые в константы.

На этом примере показан синтаксис и некоторые наиболее распространённые константы.

Parameters are documented using MediaWiki's i18n mechanism. See #Documentation for details.

Execution and output
The code actually implementing the module goes in the method. This code will generally use to get the input parameters, and will use  to get the  object to add any output to.

Query prop submodules should use to access the set of pages to operate on.

Query submodules that can be used as generators will also need to implement which is passed an  that should be filled with the generated pages. In this case, the  should generally not be used.

Caching
By default API responses are marked as not cacheable ('Cache-Control: private')! For action modules, you can allow caching by calling. This still requires clients pass the  or   parameters to actually enable caching. You can force caching by also calling.

For query modules, do not call those methods. You can allow caching by instead implementing.

In either case, be sure that private data is not exposed.

Token handling
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.

Documentation
The API is documented using MediaWiki's i18n mechanism. Needed messages generally have default names based on the modules "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.

Extending core modules
Since MediaWiki 1.14, it's possible to extend core modules' functionality using the following hooks:


 * APIGetAllowedParams to add or modify the module's parameter list
 * APIGetParamDescription to add or modify the module's parameter descriptions
 * APIAfterExecute to do something after the module has been executed (but before the result has been output)
 * Use APIQueryAfterExecute for,   and   modules
 * If the module is run in generator mode, APIQueryGeneratorAfterExecute will be called instead

List of extensions with API functionality
See API extensions for examples of extensions that add to or extend the API.

Testing your extension

 * Visit [/api.php api.php] and navigate to the generated help for your module or query submodule. Your extension's help information should be correct.
 * The example URLs you provided in  should appear under "Examples", try clicking them.
 * Omit and mangle URL parameters in the query string, check your extension's response.
 * Install and interactively explore your API.
 * Visit to see additional information about your extension.