Pomoc API MediaWiki

To jest automatycznie wygenerowana strona dokumentacji API MediaWiki.

Dokumentacja i przykłady: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Moduł główny

Stan: API MediaWiki jest ugruntowanym i stabilnym interfejsem, który jest aktywnie wspierany i ulepszany. Mimo iż staramy się tego unikać, czasami mogą mieć miejsce drastyczne zmiany; subskrybuj listę dyskusyjną mediawiki-api-announce, aby być na bieżąco ze zmianami.

Błędne żądania: Gdy zostanie wysłane błędne żądanie do API, zostanie wysłany w odpowiedzi nagłówek HTTP z kluczem „MediaWiki-API-Error” i zarówno jego wartość jak i wartość kodu błędu wysłanego w odpowiedzi będą miały taką samą wartość. Aby uzyskać więcej informacji, zobacz API: Błędy i ostrzeżenia.

Parametry:
action

Wybierz akcję do wykonania.

abusefiltercheckmatch
Sprawdź, by przekonać się, czy filtr nadużyć dopasowuje się do zestawu zmiennych, edycji lub zarejestrowanego zdarzenia filtra nadużyć.
abusefilterchecksyntax
Sprawdź składnię filtra nadużyć.
abusefilterevalexpression
Ewaluuje wyrażenie filtra nadużyć.
abusefilterunblockautopromote
Zdejmuje z użytkownika blokadę autopromocji, która została nałożona przez filtr nadużyć.
abuselogprivatedetails
Wyświetl prywatne szczegóły wpisu w rejestrze nadużyć.
antispoof
Sprawdź nazwę użytkownika według kryteriów AntiSpoof.
block
Zablokuj użytkownika.
changeauthenticationdata
Zmień dane logowania bieżącego użytkownika.
changecontentmodel
Zmień model zawartości strony
checktoken
Sprawdź poprawność tokenu z action=query&meta=tokens.
clearhasmsg
Czyści flagę hasmsg dla bieżącego użytkownika.
clientlogin
Zaloguj się na wiki używając interaktywnego flow.
compare
Pokaż porównanie dwóch stron.
createaccount
Ten moduł został wyłączony.
delete
Usuń stronę.
echomarkread
Oznacz powiadomienia jako przeczytane dla bieżącego użytkownika.
echomarkseen
Oznacz powiadomienia jako przeczytane dla bieżącego użytkownika.
echomute
Mute or unmute notifications from certain users or pages.
edit
Twórz i edytuj strony.
emailuser
Wyślij e‐mail do użytkownika.
expandtemplates
Rozwija wszystkie szablony zawarte w wikitekście.
feedcontributions
Zwraca kanał wkładu użytkownika.
feedrecentchanges
Zwraca kanał ostatnich zmian.
feedwatchlist
Zwraca kanał listy obserwowanych.
filerevert
Przywróć plik do starej wersji.
help
Wyświetl pomoc dla określonych modułów.
imagerotate
Obróć jeden lub wiecej obrazków.
import
Zaimportuj stronę z innej wiki, lub sformułuj plik XML.
linkaccount
Link an account from a third-party provider to the current user.
login
Zaloguj się i pobierz ciasteczka poświadczeń.
logout
Wyloguj i wyczyść dane sesji.
managetags
Wykonywanie zadań związanych z zarządzaniem znacznikami zmian.
mergehistory
Łączenie historii edycji.
move
Przenieś stronę.
opensearch
Przeszukaj wiki przy użyciu protokołu OpenSearch.
options
Zmienia preferencje bieżącego użytkownika.
paraminfo
Zdobądź informacje o modułach API.
parse
Parsuje treść i zwraca wynik pracy parsera.
patrol
Sprawdź stronę lub edycję.
pollsubmitvote
Moduł API AJAXPoll
problemreportsgetform
Fetch the HTML of the "report a problem" dialog.
problemreportupdate
Update or delete a problem report.
protect
Zmień poziom zabezpieczenia strony.
purge
Wyczyść pamięć podręczną dla stron o podanych tytułach.
query
Pozyskuj dane z i o MediaWiki.
regexblock
Block users' names and IP addresses via regular expressions.
regexunblock
Unblock users' names and IP addresses via regular expressions.
removeauthenticationdata
Usuń dane poświadczeń obecnego użytkownika.
reportproblem
Report a problem with a wiki page.
resetpassword
Wyślij użytkownikowi e-mail do resetowania hasła.
revisiondelete
Usuwaj i przywracaj wersje.
rollback
Wycofaj ostatnią edycję na stronie.
rsd
Export an RSD (Really Simple Discovery) schema.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
Zmień język strony.
spamblacklist
Sprawdź jeden lub więcej adresów URL pod kątem obecności na liście spamu.
spamregex
Add entries to SpamRegex or remove already blocked entries from it.
tag
Add or remove change tags from individual revisions or log entries.
templatedata
Pobierz dane zapisane przez rozszerzenie TemplateData.
thank
Wysyła powiadomienie z podziękowaniem do edytującego.
themelist
Get the list of all skins and their themes
titleblacklist
Sprawdź tytuł artykułu, pliku lub nazwy użytkownika pod kątem obecności na czarnej liście tytułów.
unblock
Odblokuj użytkownika.
undelete
Odtwórz wersje usuniętej strony.
unlinkaccount
Remove a linked third-party account from the current user.
upload
Upload a file, or get the status of pending uploads.
userrights
Zmień przynależność użytkownika do grup.
validatepassword
Validate a password against the wiki's password policies.
watch
Dodaj strony do listy obserwowanych obecnego użytkownika lub usuń je z niej.
webapp-manifest
Zwraca manifest webapp.
mobileview
Przestarzałe. Zwraca dane potrzebne dla wyświetleń mobilnych.
tokens
Przestarzałe. Get tokens for data-modifying actions.
categorytree
Wewnętrzny. Wewnętrzny moduł rozszerzenia CategoryTree.
cspreport
Wewnętrzny. 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.
scribunto-console
Wewnętrzny. Wewnętrzny moduł obsługi żądań XHR z konsoli Scribunto.
stashedit
Wewnętrzny. Prepare an edit in shared cache.
visualeditor
Wewnętrzny. Zwraca kod HTML5 strony za pośrednictwem usługi Parsoid.
visualeditoredit
Wewnętrzny. Zapisz stronę HTML5 w MediaWiki (konwertowana na wikikod przez usługę Parsoid).
Jedna z następujących wartości: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, antispoof, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, echomarkread, echomarkseen, echomute, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, pollsubmitvote, problemreportsgetform, problemreportupdate, protect, purge, query, regexblock, regexunblock, removeauthenticationdata, reportproblem, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, spamblacklist, spamregex, tag, templatedata, thank, themelist, titleblacklist, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, mobileview, tokens, categorytree, cspreport, scribunto-console, stashedit, visualeditor, visualeditoredit
Domyślnie: help
format

Format danych wyjściowych.

json
Dane wyjściowe w formacie JSON.
jsonfm
Dane wyjściowe w formacie JSON (prawidłowo wyświetlane w HTML).
none
Output nothing.
php
Dane wyjściowe w serializowany formacie PHP.
phpfm
Dane wyjściowe w serializowanym formacie PHP (prawidłowo wyświetlane w HTML).
rawfm
Output data, including debugging elements, in JSON format (pretty-print in HTML).
xml
Dane wyjściowe w formacie XML.
xmlfm
Dane wyjściowe w formacie XML (prawidłowo wyświetlane w HTML).
Jedna z następujących wartości: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Domyślnie: jsonfm
maxlag

Maksymalne opóźnienie mogą być używane kiedy MediaWiki jest zainstalowana w klastrze zreplikowanej bazy danych. By zapisać działania powodujące większe opóźnienie replikacji, ten parametr może wymusić czekanie u klienta, dopóki opóźnienie replikacji jest mniejsze niż określona wartość. W przypadku nadmiernego opóźnienia, kod błędu maxlag jest zwracany z wiadomością jak Oczekiwanie na $host: $lag sekund opóźnienia.
Zobacz Podręcznik:Parametr Maxlag by uzyskać więcej informacji.

Typ: liczba całkowita
smaxage

Ustaw nagłówek HTTP kontrolujący pamięć podręczną s-maxage na taką ilość sekund. Błędy nie będą nigdy przechowywane w pamięci podręcznej.

Typ: liczba całkowita
Domyślnie: 0
maxage

Ustaw nagłówek HTTP kontrolujący pamięć podręczną maxage na taką ilość sekund. Błędy nie będą nigdy przechowywane w pamięci podręcznej.

Typ: liczba całkowita
Domyślnie: 0
assert

Zweryfikuj, czy użytkownik jest zalogowany, jeżeli wybrano user, niezalogowany, jeżeli wybrano anon, lub czy ma uprawnienia bota, jeżeli wybrano bot.

Jedna z następujących wartości: anon, bot, user
assertuser

Sprawdź, czy bieżący użytkownik posiada nazwę.

Typ: użytkownik, podany jako: nazwa użytkownika
requestid

Każda wartość tu podana będzie dołączana do odpowiedzi. Może być użyta do rozróżniania żądań.

servedby

Dołącz do odpowiedzi nazwę hosta, który obsłużył żądanie.

Typ: wartość boolowska (szczegóły)
curtimestamp

Dołącz obecny znacznik czasu do wyniku.

Typ: wartość boolowska (szczegóły)
responselanginfo

Dołącz języki użyte w uselang i errorlang do wyniku.

Typ: wartość boolowska (szczegóły)
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.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, the Access-Control-Allow-Origin and Access-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, but Access-Control-Allow-Credentials will be false and all user-specific data will be restricted.

uselang

Język, w którym mają być pokazywane tłumaczenia komunikatów. action=query&meta=siteinfo z siprop=languages zwróci listę języków lub ustaw jako user, aby pobrać z preferencji zalogowanego użytkownika lub content, aby wykorzystać język zawartości tej wiki.

Domyślnie: user
errorformat

Format tekstu ostrzeżeń i błędów.

plaintext
Wikitekst z usuniętymi znacznikami HTML i zamienionymi encjami.
wikitext
Nieprzeparsowany wikitekst.
html
HTML.
raw
Nazwa komunikatu i parametry.
none
Brak tekstu na wyjściu, tylko kody błędów.
bc
Format używany przed MediaWiki 1.29. errorlang i errorsuselocal są ignorowane.
Jedna z następujących wartości: bc, html, none, plaintext, raw, wikitext
Domyślnie: bc
errorlang

Język, w którym mają być pokazywane ostrzeżenia i błędy. action=query&meta=siteinfo z siprop=languages zwróci listę języków lub ustaw jako content, aby wykorzystać język zawartości tej wiki. Możesz też ustawić jako uselang, aby użyć tej samej wartości co parametr uselang.

Domyślnie: uselang
errorsuselocal

Jeśli podano, teksty błędów będą używały lokalnie zmodyfikowanych komunikatów z przestrzeni MediaWiki.

Typ: wartość boolowska (szczegóły)
Przykłady:
Pomoc dla modułu głównego
api.php?action=help [otwórz w brudnopisie]
Cała pomoc na jednej stronie.
api.php?action=help&recursivesubmodules=1 [otwórz w brudnopisie]
Uprawnienia:
writeapi
Zapis poprzez interfejs API
Przydzielone dla: all, user, bot oraz globalbot
apihighlimits
Użyj wyższych limitów w zapytaniach API (dla zapytań powolnych: 500; dla zapytań szybkich: 5000). Limity zapytań powolnych są także stosowane dla parametrów z podanymi wieloma wartościami.
Przydzielone dla: bot, sysop, staff, globalbot oraz intern

Typy danych

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

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.

expiry

Expiry values may be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). For no expiry, use infinite, indefinite, infinity or 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.

Twórcy

Deweloperzy API:

  • Roan Kattouw (główny programista wrzesień 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (twórca, główny programista wrzesień 2006–wrzesień 2007)
  • Brad Jorsch (główny programista 2013–obecnie)

Prosimy wysyłać komentarze, sugestie i pytania do mediawiki-api@lists.wikimedia.org lub zgłoś błąd na https://phabricator.wikimedia.org/.