API:Etiquette/pl

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

Pomoc

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

Limity żądań
Nie ma limitu twardości i szybkości w żądaniach odczytu, ale prosimy o byciu rozsądnym i nie spowodowanie przeciążenia strony. Większość operatorów zastrzega sobie prawo do bezceremonialnego zablokowania, jeżeli Twoje działania zagrażają stabilność strony.

Jeżeli wywołujesz żądania po kolei, zamiast równolegle (tj. czekasz na zakończenie wcześniejszego żądania zanim zostanie wysłane nowe, co oznacza, że nigdy nie wykonujesz więcej niż jedno żądanie w tym samym czasie), to powinno być wszystko dobrze. Także spróbuj połączyć kilka rzeczy w jedno żądanie. Na przykład: określ kilka tytułów, oddzielając je '|' w parametrze  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
Tam gdzie to możliwe odpytuj o wyniki, podając określony numer wersji, ponieważ pobranie takiej brakującej informacji jest obciążające dla serwera. Aby pobrać określoną wersję, użyj parametru 'oldid', przykład:


 * [//en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=254862759 en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=254862759]
 * [//en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=462841413 en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=462841413]

Użycie parametru maxlag
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:

Nagłówek User-Agent
Użyj opisowego nagłówka, 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
Jeżeli próbujesz ustalić dlaczego otrzymujesz wyniki wolniej niż byś chciał, przejrzyj, 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.