API:Etykieta

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page API:Etiquette and the translation is 100% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎فارسی • ‎français • ‎Հայերեն • ‎日本語 • ‎polski • ‎română • ‎русский • ‎sicilianu • ‎中文
Tools clipart.png Ta strona jest częścią dokumentacji API akcji MediaWiki.

API akcji MediaWiki

v · d · e
Trwają prace nad tą stroną.

Przeczytaj też przewodnik szybkiego startu. Odpowiada on na niektóre pytania, których tutaj nie ma, oraz poleca inne użyteczne strony.

Pomoc[edit]

  1. Przeczytaj to FAQ.
  2. Spróbuj znaleźć odpowiedź na swoje pytanie w dokumentacji API, w API sandbox lub na stronie głównej dokumentacji wbudowanej w API.
  3. Jeżeli nie możesz znaleźć odpowiedzi na swoje pytanie w sieci, możesz zadać je na liście dyskusyjnej mediawiki-api.

Zachowanie[edit]

Limity żądań[edit]

Nie ma ścisłych limitów dotyczących żądań odczytu, ale prosimy o bycie rozsądnym i nie spowodowanie przeciążenia strony. Większość administratorów systemów zastrzega sobie prawo do bezceremonialnego zablokowania Ciebie, jeżeli Twoje działania zagrażają stabilności strony.

Jeżeli wywołujesz żądania po kolei, zamiast równolegle (tj. czekasz na zakończenie wcześniejszego żądania zanim wyślesz nowe, co oznacza, że nigdy nie wykonujesz więcej niż jedno żądanie w tym samym czasie), to powinno być wszystko dobrze. Spróbuj także połączyć kilka rzeczy w jedno żądanie. Na przykład: określ kilka tytułów, oddzielając je '|' w parametrze titles zamiast wykonywania kolejnych żądań dla każdego tytułu z osobna; użyj "generatora" zamiast tworzenia żądania dla każdego wyniku z innego żądania.

Parsowanie wersji[edit]

Choć jest możliwe odpytanie o wyniki dla konkretnej wersji, jest to obciążające dla serwera. Aby pobrać określoną wersję, użyj parametru 'oldid', przykład:

Użycie parametru maxlag[edit]

Jeżeli Twoje zadanie nie jest interaktywne (tj. użytkownik nie czeka na wynik), powinieneś wykorzystać parametr maxlag. Zapobiegnie to uruchomieniu Twojego zadania, kiedy serwer jest zbyt obciążony. Większe wartości oznaczają bardziej agresywne zachowanie, niższe są przyjemniejsze.

Zobacz: Podręcznik:Parametr MaxlagManual:Maxlag parameter

Nagłówek User-Agent[edit]

Użyj opisowego nagłówka User-Agent, który zawiera nazwę Twojej aplikacji i najlepiej też Twój adres e-mail. Nie kopiuj user-agent'a popularnych przeglądarek (Dopóki Twój klient API nie jest aplikacją JavaScript, uruchomioną przez wspomnianą przeglądarkę poprzez Ajax; w tym przypadku nie ma możliwości zmiany user-agent). Dzięki temu jest pewność, że będzie można wyśledzić źródło problemu jeżeli takowy wystąpi. Zobacz API:Main page#Identifying your client oraz m:User-Agent policy aby uzyskać szczegóły.

Ogólne ujęcie wydajności[edit]

Jeżeli próbujesz ustalić dlaczego otrzymujesz wyniki wolniej niż byś chciał, przejrzyj Performance guidelinesPerformance guidelines, które pomogą ogólnie zrozumieć kwestie wydajności. Jeżeli stwierdzisz, że odczyt za pomocą API, zamiast bezpośredniego odczytywania z baz danych, utrudnia funkcjonowanie klienta, rozważ umieszczenie go w Wikimedia Toolforge.