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-or-later
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. - block
- Zablokuj użytkownika.
- changeauthenticationdata
- Zmień dane logowania bieżącego użytkownika.
- checktoken
- Sprawdź poprawność tokenu z action=query&meta=tokens.
- clearhasmsg
- Czyści flagę hasmsgdla bieżącego użytkownika.
- clientlogin
- Log in to the wiki using the interactive flow.
- compare
- Pokaż porównanie dwóch stron.
- createaccount
- Utwórz nowe konto.
- cspreport
- 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.
- delete
- Usuń stronę.
- 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
- Log in and get authentication cookies.
- 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
- Parses content and returns parser output.
- patrol
- Sprawdź stronę lub edycję.
- protect
- Zmień poziom zabezpieczenia strony.
- purge
- Wyczyść pamięć podręczną dla stron o podanych tytułach.
- query
- Fetch data from and about MediaWiki.
- removeauthenticationdata
- Remove authentication data for the current user.
- resetpassword
- Wyślij użytkownikowi e-mail do resetowania hasła.
- revisiondelete
- Delete and undelete revisions.
- rollback
- Undo the last edit to the page.
- rsd
- Export an RSD (Really Simple Discovery) schema.
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- Zmień język strony.
- stashedit
- Prepare an edit in shared cache.
- tag
- Add or remove change tags from individual revisions or log entries.
- unblock
- Odblokuj użytkownika.
- undelete
- Restore revisions of a deleted page.
- unlinkaccount
- Remove a linked third-party account from the current user.
- upload
- Upload a file, or get the status of pending uploads.
- userrights
- Change a user's group membership.
- validatepassword
- Validate a password against the wiki's password policies.
- watch
- Add or remove pages from the current user's watchlist.
- tokens
- Przestarzałe. Get tokens for data-modifying actions.
 
- 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, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, tokens
- 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-maxagena 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ą - maxagena 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 - Originheader 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- Originheader, a 403 response will be returned. If this parameter matches the- Originheader and the origin is whitelisted, the- Access-Control-Allow-Originand- Access-Control-Allow-Credentialsheaders will be set.- For non-authenticated requests, specify the value *. This will cause the - Access-Control-Allow-Originheader to be set, but- Access-Control-Allow-Credentialswill be- falseand 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, 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.
- 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.
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/.