MediaWiki API to dobrze udokumentowany zestaw narzędzi programistycznych, które mogą wykonać większość zadań w jednym skrypcie. Interfejs API jest zwykle używany do tworzenia zautomatyzowanych narzędzi do użytku na wiki. Interfejs API MediaWiki może być łatwo używany przez większość języków, w szczególności PHP (funkcje curl), a także Perl i kilka innych..
Kroki
Krok 1. Przeczytaj dokumentację API MediaWiki
Znajduje się w 'api.php' w tym samym katalogu co zwykły index.php. Przykład:
Krok 2. Wybierz format wyjściowy
MediaWiki oferuje dane wyjściowe w postaci JSON, JSONFM, PHP (format serializowany), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM i RAWFM. Formaty z przyrostkiem „FM” są ładnie wydrukowane w HTML.
Krok 3. Wybierz akcję
MediaWiki API obsługuje następujące akcje:
- pomoc - Zobacz ekran pomocy
- logowanie - Zaloguj się do MediaWiki
- opensearch - Implementuj protokół opensearch. (Nie wszystkie instalacje MediaWiki mają to).
- feedwatchlist - Zwróć kanał z listy obserwowanych.
- zapytanie - ma wiele opcji. Zapoznaj się z ich dokumentacją MediaWiki API.
Krok 4. Wybierz zapytanie lub listę
Poza standardowymi akcjami, MediaWiki obsługuje różne zapytania i listy, takie jak lista stron zawierających link do innego artykułu, liczba ostatnich zmian, różnice, wkłady itp.
Krok 5. Przekaż wysłane dane do API za pomocą CURL lub innego narzędzia, które pozwala na użycie metody POST do skryptu
Metoda GET również może działać.
Krok 6. Upewnij się, że pliki cookie są wysyłane do aplikacji (niektóre skrypty/aplikacje mogą chcieć przechowywać je w podfolderze
Krok 7. Podczas interakcji z interfejsem użytkownika MediaWiki pamiętaj o tokenie edycji przechowywanym na większości stron edycji
Token edycji jest używany do określania kolizji edycji i unikania zastępowania innej już wykonanej edycji (jest to również używane przy cofaniu). Pamiętaj, że łatwiej jest coś pójść nie tak, jeśli działasz z interfejsem użytkownika wiki. Pamiętaj o wszelkich wyrażeniach regularnych, których używasz, aby upewnić się, że przyniosą one tylko zamierzony rezultat.
Krok 8. Przeczytaj wyniki przesłane przez wiki
Wyniki zostaną przesłane do Ciebie w odpowiedzi HTTP, którą może odczytać wiele parserów. Zadbaj o wybrany format. Upewnij się, że używasz odpowiedniego parsera dla tego formatu. Zwykle dobrą praktyką jest jawne określenie formatu w MediaWiki, nawet jeśli ma domyślny format, którego chcesz użyć.
Porady
- Przed użyciem interfejsu API upewnij się, że obsługujesz skrypt na lokalnej wiki.
- Możesz dowiedzieć się więcej o MediaWiki, korzystając z jej API.
