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.

adddomainalias
Add a domain alias to the wiki
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.
checkwikistatus
Sprawdza, czy proces tworzenia nowej Wiki zakończył się i zwraca status całego procesu, a także statusy dla poszczególnych kroków.
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.
confirmemail
createaccount
Utwórz nowe konto.
createnewwiki
Inicjuje proces tworzenia nowej Wiki.
delete
Usuń stronę.
edit
Twórz i edytuj strony.
emailuser
Wyślij e‐mail do użytkownika.
embedvideo
Get generated video embed code for given parameters.
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.
getmap
help
Wyświetl pomoc dla określonych modułów.
imagerotate
Obróć jeden lub wiecej obrazków.
imageserving
This module is used to return one image URL for the specified article given either the article ID or article title (with prefix if applicable).
import
Zaimportuj stronę z innej wiki, lub sformułuj plik XML.
infobox
This module provides infobox parser
isuserscheduledforclosure
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.
maintenance
managetags
Wykonywanie zadań związanych z zarządzaniem znacznikami zmian.
mergehistory
Łączenie historii edycji.
modifydomainalias
Modify a domain alias to the wiki
move
Przenieś stronę.
multifindcharacter
notifications
Retrieve notifications for the current user.
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ę.
protect
Zmień poziom zabezpieczenia strony.
purge
Wyczyść pamięć podręczną dla stron o podanych tytułach.
purgeimages
query
Pozyskuj dane z i o MediaWiki.
removeauthenticationdata
Usuń dane poświadczeń obecnego użytkownika.
removedomainalias
Remove a domain alias for the wiki
renameuser
reopenwiki
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.
savemap
savetheme
scheduledebuglonglivedtask
schedulesearchindexupdate
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
Zmień język strony.
tag
Add or remove change tags from individual revisions or log entries.
tagsreport
templatedata
Implementacja API zapewniająca zastąpienie rozszerzenie TemplateData. Używany przez VisualEditor do pobierania odpowiednich parametrów szablonów do transkluzji
thank
Wysyła powiadomienie z podziękowaniem do edytującego.
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.
updateprimarydomain
Update the primary domain of a wiki
updateuseremail
upload
Upload a file, or get the status of pending uploads.
uploadimage
userrights
Zmień przynależność użytkownika do grup.
validatepassword
Validate a password against the wiki's password policies.
verifytask
watch
Dodaj strony do listy obserwowanych obecnego użytkownika lub usuń je z niej.
webapp-manifest
Zwraca manifest webapp.
annotatewikinotspam
Wewnętrzny. Wiki opisana jako nie spam
categorytree
Wewnętrzny. Wewnętrzny moduł rozszerzenia CategoryTree.
clearwikiconfigcache
Wewnętrzny. Usuń pamięć podręczną konfiguracji dla danej wiki.
createwikiconfigvariabledefinition
Wewnętrzny. Utwórz zmienną konfiguracji.
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.
details
Wewnętrzny.
linksuggest
Wewnętrzny.
listusersnamesearch
Wewnętrzny.
listuserssearchuser
Wewnętrzny.
listwikiswithextension
Wewnętrzny. Pobierz listę wiki, na których rozszerzenie jest włączone.
listwikiswithvariable
Wewnętrzny. Pobierz listę wiki, w których zmienna posiada podany stan.
lookupcontribs
Wewnętrzny. Lookup user contributions
markwikiclosed
Wewnętrzny. Oznacz daną wiki jako zamkniętą (niedostępną publicznie).
markwikiopen
Wewnętrzny. Oznacz daną wiki jako otwartą (dostępną publicznie).
markwikiprotected
Wewnętrzny. Oznacz daną wiki jako chronioną, aby nie dało się jej zamknąć.
masseditwikis
Wewnętrzny. Zmień zmienne konfiguracji dla listy wiki.
multidelete
Wewnętrzny.
refreshlinks
Wewnętrzny.
removephalanxblock
Wewnętrzny.
removewikiconfigvariable
Wewnętrzny. Usuń zmienną konfiguracji dla wiki.
savewikiconfigvariable
Wewnętrzny. Ustaw zmienną konfiguracji dla wiki.
scribunto-console
Wewnętrzny. Wewnętrzny moduł obsługi żądań XHR z konsoli Scribunto.
stashedit
Wewnętrzny. Prepare an edit in shared cache.
suggestwiki
Wewnętrzny.
suggestwikis
Wewnętrzny. Pobierz listę wiki, których domena zawiera wyszukiwany zwrot.
togglephalanxblock
Wewnętrzny.
updateHubs
Wewnętrzny. Uaktualnia kategorie i temat wiki
updatewikiconfigvariabledefinition
Wewnętrzny. Aktualizuj właściwości istniejącej zmiennej konfiguracji.
variableinfo
Wewnętrzny. Uzyskaj szczegółowe informacje na temat danej zmiennej konfiguracji.
variableupdate
Wewnętrzny. Uaktualnij informacje o zmiennej
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: adddomainalias, block, changeauthenticationdata, changecontentmodel, checktoken, checkwikistatus, clearhasmsg, clientlogin, compare, confirmemail, createaccount, createnewwiki, delete, edit, emailuser, embedvideo, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, getmap, help, imagerotate, imageserving, import, infobox, isuserscheduledforclosure, linkaccount, login, logout, maintenance, managetags, mergehistory, modifydomainalias, move, multifindcharacter, notifications, opensearch, options, paraminfo, parse, patrol, protect, purge, purgeimages, query, removeauthenticationdata, removedomainalias, renameuser, reopenwiki, resetpassword, revisiondelete, rollback, rsd, savemap, savetheme, scheduledebuglonglivedtask, schedulesearchindexupdate, setnotificationtimestamp, setpagelanguage, tag, tagsreport, templatedata, thank, titleblacklist, unblock, undelete, unlinkaccount, updateprimarydomain, updateuseremail, upload, uploadimage, userrights, validatepassword, verifytask, watch, webapp-manifest, annotatewikinotspam, categorytree, clearwikiconfigcache, createwikiconfigvariabledefinition, cspreport, details, linksuggest, listusersnamesearch, listuserssearchuser, listwikiswithextension, listwikiswithvariable, lookupcontribs, markwikiclosed, markwikiopen, markwikiprotected, masseditwikis, multidelete, refreshlinks, removephalanxblock, removewikiconfigvariable, savewikiconfigvariable, scribunto-console, stashedit, suggestwiki, suggestwikis, togglephalanxblock, updateHubs, updatewikiconfigvariabledefinition, variableinfo, variableupdate, 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

Łącząc się z API używając żądań AJAX z innej domeny internetowej (CORS) ustaw wartość tego parametru na domenę źródłową. Parametr ten musi być uwzględniony w każdym podstawowym żądaniu, toteż musi być częścią URI żądania (nie częścią żądania POST).

W uwierzytelnionych żądaniach wartość tego parametru musi dokładnie odpowiadać jednej ze źródłowych domen w nagłówku Origin, powinna więc pasować do wzoru https://en.wikipedia.org lub https://meta.wikimedia.org. Jeżeli parametr nie odpowiada nagłówkowi Origin, zwrócona zostanie odpowiedź z błędem 403. Jeżeli parametr odpowiada nagłówkowi Origin, a domena źródłowa należy do akceptowanych, ustawione zostaną nagłówki Access-Control-Allow-Origin oraz Access-Control-Allow-Credentials.

W nieuwierzytelnionych żądaniach podaj wartość *. Sprawi to, że ustawiony zostanie nagłówek Access-Control-Allow-Origin, jednak nagłówek Access-Control-Allow-Credentials otrzyma wartość false a wszelkie dane dotyczące użytkownika będą ograniczone.

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
variant

Variant of the language. Only works if the base language supports variant conversion.

errorformat

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

plaintext
Wikitekst z usuniętymi znacznikami HTML i zastąpionymi encjami.
wikitext
Nieprzeparsowany wikitekst.
html
HTML
raw
Klucz komunikatu i parametry.
none
Brak tekstu wyjściowego, tylko kody błędów.
bc
Format używany przed MediaWiki w wersji 1.29. Parametry errorlang oraz 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 oraz bot
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, helper, soap, wiki-representative oraz wiki-specialist

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/.