Pomoc MediaWiki API
To jest automatycznie wygenerowana strona dokumentacji MediaWiki API. Dokumentacja i przykłady: https://www.mediawiki.org/wiki/API
Moduł główny
- Źródło: MediaWiki
- Licencja: GPL-2.0+
Stan: Wszystkie funkcje opisane na tej stronie powinny działać, ale API nadal jest aktywnie rozwijane i mogą się zmienić w dowolnym czasie. Subskrybuj listę dyskusyjną mediawiki-api-announce, aby móc na bieżąco dowiadywać się o aktualizacjach.
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.
Testowanie: Aby łatwo testować żądania API, zobacz Special:ApiSandbox.
- action
Wybierz akcję do wykonania.
- Jedna z następujących wartości: block, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, stashedit, tag, tokens, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch
- Domyślnie: help
- format
Format danych wyjściowych.
- 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, lub czy ma uprawnienia bota, jeżeli wybrano bot.
- Jedna z następujących wartości: user, bot
- assertuser
Sprawdź, czy bieżący użytkownik posiada nazwę.
- Typ: 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ść logiczna (szczegóły)
- curtimestamp
Dołącz obecny znacznik czasu do wyniku.
- Typ: wartość logiczna (szczegóły)
- responselanginfo
Include the languages used for uselang and errorlang in the result.
- Typ: wartość logiczna (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 theOrigin
header, a 403 response will be returned. If this parameter matches theOrigin
header and the origin is whitelisted, theAccess-Control-Allow-Origin
andAccess-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, butAccess-Control-Allow-Credentials
will befalse
and all user-specific data will be restricted.- uselang
Język, w którym mają być pokazywane tłumaczenia wiadomości. 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 to use for warning and error text output.
- plaintext
- Wikitext with HTML tags removed and entities replaced.
- wikitext
- Unparsed wikitext.
- html
- HTML.
- raw
- Message key and parameters.
- none
- No text output, only the error codes.
- bc
- Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
- Jedna z następujących wartości: plaintext, wikitext, html, raw, none, bc
- Domyślnie: bc
- errorlang
Language to use for warnings and errors. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify content to use this wiki's content language, or specify uselang to use the same value as the uselang parameter.
- Domyślnie: uselang
- errorsuselocal
If given, error texts will use locally-customized messages from the MediaWiki namespace.
- Typ: wartość logiczna (szczegóły)
- 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]
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.
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.
- timestamp
- Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
- ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
- ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
- MediaWiki format, 20010115145600
- Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
- EXIF format, 2001:01:15 14:56:00
- RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
- RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
- C ctime format, Mon Jan 15 14:56:00 2001
- Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
- The string now
- alternative multiple-value separator
- 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.
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/.