API:Головна сторінка

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page API:Main page and the translation is 51% complete.

Other languages:
العربية • ‎български • ‎বাংলা • ‎čeština • ‎dansk • ‎Deutsch • ‎English • ‎Esperanto • ‎español • ‎فارسی • ‎français • ‎हिन्दी • ‎Հայերեն • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎Taqbaylit • ‎ಕನ್ನಡ • ‎한국어 • ‎lietuvių • ‎文言 • ‎मैथिली • ‎मराठी • ‎Nederlands • ‎occitan • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎سنڌي • ‎ไทย • ‎українська • ‎Tiếng Việt • ‎粵語 • ‎中文
Ця сторінка є частиною документації по MediaWiki action API.

MediaWiki action API

v · d · e
Це огляд «action» API. Див. рядок меню праворуч для отримання детальніших підтем та інших API.

MediaWiki action API є веб-службою, яка надає зручний доступ до вікі-функцій, даних і метаданих через HTTP, за URL-ом зазвичай на api.phpManual:api.php. Клієнти запитують конкретні «дії», які вказуються у параметрі action, переважно action=query для отримання інформації. Це так зване MediaWiki API, однак є й інші веб-API, доступні для з'єднання з MediaWiki, як-от RESTBase і Служба запитів Вікіданих.

Вступ

Якщо ви натомість шукаєте «внутрішнє API» чи «PHP API», див. інтерфейс розширень, який дозволяє PHP розробникам додавати нову функціональність до встановленого MediaWiki.
Сповіщення про застарілість надсилаються за списком розсилки mediawiki-api-announce з низьким рівнем трафіку. Рекомендуємо підписатися.

MediaWiki action API може використовуватися для нагляду за MediaWiki-проектом чи створення боту для автоматичної його підтримки. Він забезпечує прямий, високорівневий доступ до даних, що містяться в базах даних MediaWiki. Клієнтські програми можуть автоматично входити до вікі, отримувати дані та публікувати зміни, роблячи HTTP-запити веб-службі. Підтримувані клієнти включають ботів, тонкі JavaScript веб-клієнти, як-от Navigation popups та LiveRC, користувацькі застосунки на кшталт Vandal Fighter й інші веб-сайти (утиліти Toolforge).

На нових встановленнях MediaWiki веб-служба увімкнена за замовчуванням, але адміністратор може вимкнути її.

MediaWiki має інші два зовнішні інтерфейси:

  • Сторінка Special:Export, яка надає масовий експорт вмісту вікі в XML. Читайте Help:ExportHelp:Export для отримання додаткової інформації.
  • Стандартний веб-інтерфейс (який ви, скоріше за все, використовуєте просто зараз для перегляду цієї сторінки). Читайте Manual:Parameters to index.phpManual:Parameters to index.php для інформації з використання веб-інтерфейсу.

Простий приклад

Цей URL каже API веб-сервісу Англійської Вікіпедії надіслати вам вміст головної сторінки.

https://en.wikipedia.org/w/api.php?action=query&titles=Main%20Page&prop=revisions&rvprop=content&format=json&formatversion=2

Використовуйте будь-яку мову програмування для HTTP GET-запитів для того URL (або просто відвідайте те посилання у своєму браузері), і ви отримаєте JSON-документ, який містить поточну вікі-розмітку для сторінки під назвою «Main Page». Заміна формату на jsonfm поверне «pretty-printed» HTML-результат, добрий для налагодження.

Тут jsonfm URL як легкочитне посилання, яке можна натиснути.

Давайте розберемо цей URL по частинах, аби показати, як він працює.

Кінцева точка

https://en.wikipedia.org/w/api.php

Це «кінцева точка». Це як домашня сторінка API веб-сервісу MediaWiki. Цей URL є базовим URL для API Англійської Вікіпедії, просто як https://en.wikipedia.org/wiki/ є базовим URL для його веб-сайту.

Якщо ви пишете програму для використання Англійської Вікіпедії, кожен побудований URL починатиметься з цього базового URL. Якщо ви використовуєте іншу інсталяцію MediaWiki, вам необхідно знайти її кінцеву точку та використати її натомість. Всі вікі Вікімедіа мають кінцеві точки, що відповідають цьому шаблону:

https://www.mediawiki.org/w/api.php     # MediaWiki API
https://en.wikipedia.org/w/api.php      # API Англійської Вікіпедії
https://nl.wikipedia.org/w/api.php      # API Нідерландської Вікіпедії
https://commons.wikimedia.org/w/api.php # API Вікісховища


Версії MediaWiki: 1.17

Починаючи з r75621, ми маємо RSD відкриття кінцевої точки: шукайте link rel="EditURI" у коді HTML будь-якої сторінки та видобувайте api.php URL; актуальне посилання містить додаткову інформацію. Наприклад, на цій вікі це:

<link rel="EditURI" type="application/rsd+xml" href="//www.mediawiki.org/w/api.php?action=rsd" />

Інакше, це не є безпечним способом визначення кінцевої точки на будь-якій вікі. Якщо вам пощастить, то або повний шлях до index.php не буде прихований дивними правилами перезапису, то ж вам потрібно лише взяти посилання «редагувати» (чи історія) та замінити index.php (ін.) на api.php, або ви матимете змогу використати шлях сценаріїв за замовчуванням (як w/api.php).

Тепер перейдімо до параметрів у рядку запиту URL.

Формат

format=json Це каже API, що ми хочемо повернення даних у форматі JSON. Ви також можете захотіти спробувати format=jsonfm для отримання HTML-версії результату, доброї для налагодження. API підтримує інші формати виведення, як-от XML і рідний PHP, але планується вилучити менш популярні формати (phab:T95715), тому ви можете не захотіти використовувати їх.

Дія

action=query

API веб-служби MediaWiki реалізує дюжини дій, а розширень реалізовано набагато більше; динамічно згенерована довідка API документує всі доступні дії на вікі. У цьому випадку, ми використовуємо дію «query» для отримання деякої інформації. Дія «query» є однією з найважливіших дій API, і вона має вичерпну документацію. What follows is just an explanation of a single example.

Action-specific parameters

titles=Main%20Page

The rest of the example URL contains parameters used by the "query" action. Here, we're telling the web service API that we want information about the Wiki page called "Main Page". (The %20 comes from percent-encoding a space.) If you need to query multiple pages, put them all in one request to optimize network and server resources: titles=PageA|PageB|PageC. See the query documentation for details.

prop=revisions

You can request many kinds of information, or properties, about a page. This parameter tells the web service API that we want information about a particular revision of the page. Since we're not specifying any revision information, the API will give us information about the latest revision — the main page of Wikipedia as it stands right now.

rvprop=content

Finally, this parameter tells the web service API that we want the content of the latest revision of the page. If we passed in rvprop=content|user instead, we'd get the latest page content and the name of the user who made the most recent revision.

Again, this is just one example. Queries are explained in more detail here, and the API reference lists all the possible actions, all the possible values for rvprop, and so on.

An introduction to the API by Roan Kattouw at the San Francisco Hackathon January 2012


Getting started

Before you start using the MediaWiki web service API, be sure to read these documents:

Beyond that point, what you need to read depends on what you want to do. The right-hand menu links to detailed, task-specific documentation, and some more general guidelines are given below.

Identifying your client

When you make HTTP requests to the MediaWiki web service API, be sure to specify a User-Agent header that properly identifies your client. Don't use the default User-Agent provided by your client library, but make up a custom header that identifies your script or service and provides some type of means of contacting you (e.g., an e-mail address).

An example User-Agent string might look like:

MyCoolTool/1.1 (https://example.org/MyCoolTool/; MyCoolTool@example.org) BasedOnSuperLib/1.4

On Wikimedia wikis, if you don't supply a User-Agent header, or you supply an empty or generic one, your request will fail with an HTTP 403 error (cf. m:User-Agent policy). Other MediaWiki installations may have similar policies.

If you are calling the API from browser-based JavaScript, you won't be able to influence the User-Agent header: the browser will use its own. To work around this, use the Api-User-Agent header:

// Using XMLHttpRequest
xhr.setRequestHeader( 'Api-User-Agent', 'Example/1.0' );

// Using jQuery
$.ajax( {
    url: remoteUrlWithOrigin,
    data: queryData,
    dataType: 'json',
    type: 'POST',
    headers: { 'Api-User-Agent': 'Example/1.0' },
    success: function(data) {
       // do something with data
    }
} );

// Using mw.Api, specify it when creating the mw.Api object
var api = new mw.Api( {
    ajax: {
        headers: { 'Api-User-Agent': 'Example/1.0' }
    }
} );
api.get( {...} ).done(function(data) {
    // do something with data
});

// Using fetch
fetch( remoteUrlWithOrigin, {
    method: 'POST',
    headers: new Headers( {
        'Api-User-Agent': 'Example/1.0'
    } )
    // Other init settings such as 'credentials'
} ).then( function ( response ) {
    if ( response.ok ) {
        return response.json();
    }
    throw new Error( 'Network response was not ok: ' + response.statusText );
} ).then( function ( data ) {
    // do something with data
});

In PHP, you can identify your user-agent with code such as this:

ini_set('user_agent', 'MyCoolTool/1.1 (https://example.org/MyCoolTool/; MyCoolTool@example.org) BasedOnSuperLib/1.4');

Or if you use cURL:

curl_setopt($curl, CURLOPT_USERAGENT, 'MyCoolTool/1.1 (https://example.org/MyCoolTool/; MyCoolTool@example.org) BasedOnSuperLib/1.4');

Logging in

Your client will probably need to log in to MediaWiki, possibly via its own user account. See the login manual page for details.

API etiquette

Please also read: API:Etiquette

If your requests obtain data that can be cached for a while, you should take steps to cache it, so you don't request the same data over and over again. More information about rate-limiting, concurrency, and general API etiquette can be found at API:Etiquette. Some clients may be able to cache data themselves, but for others (particularly JavaScript clients), this is not possible.

Per the HTTP specification, POST requests cannot be cached. Therefore, whenever you're reading data from the web service API, you should use GET requests, not POST.

Also note that a request cannot be served from cache unless the URL is exactly the same. If you make a request for api.php?....titles=Foo|Bar|Hello, and cache the result, then a request for api.php?....titles=Hello|Bar|Hello|Foo will not go through the cache — even though MediaWiki returns the same data!

You should take care to normalize the URLs you send to the MediaWiki web service, so that slightly different user input won't cause you to waste time on unnecessary HTTP requests. You can normalize a list of page titles by removing duplicates and sorting the titles alphabetically. Similar techniques will work for other kinds of data.

Useful links

The menu bar on the right side of this page links to more detailed, task-specific documentation. Here are some links having to do with the API as a whole:

Archived links