API:Etiquette/it

Vedi anche la guida per iniziare velocemente. Risponde ad alcune domande non risposte qui e indirizza ad altre pagine utili.

Aiuto

 * 1) Leggi questa FAQ.
 * 2) Prova a trovare la risposta alla tua domanda nella documentazione delle API, nella sandbox delle API o nella pagina principale delle API auto-documentata.
 * 3) Se non trovi la risposta alla tua domanda nel web, puoi porre una domanda nella mailing-list mediawiki-api.

Limiti di richieste
Non c'è un limite fisso sulle richieste in lettura, ma ti chiediamo di essere così gentile da non tentare di interrompere il servizio di un sito. Molti amministratori di sistema si riservano il diritto di bloccarti senza tanti complimenti se metti a repentaglio la stabilità del loro sito.

Se effettui le tue richieste in serie invece che in parallelo (ad esempio se aspetti che una richiesta finisca prima di inviarne una nuova, in modo da non fare più di una richiesta nello stesso momento), allora sei certamente a posto. Tenta altresì di combinare le cose in una singola richiesta. Ad esempio: specifica più titoli separati da '|' nel parametro  invece che fare una nuova richiesta per ogni titolo; usa un "generatore" invece che effettuare una richiesta per ogni singolo risultato da un'altra richiesta.

Analizzare le revisioni
Sebbene sia possibile ottenere dei risultati da uno specifico numero di revisione, questa è un'operazione dispensiva per i server. Per ottenere una specifica revisione usa il parametro 'oldid', ad esempio:


 * [//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]

Utilizzo del parametro maxlag
Se il tuo compito non richiede interazione (ad esempio se l'utente non attende per il risultato) dovresti utilizzare il parametro maxlag. Questo preverrà che il tuo lavoro continui a rimanere in esecuzione mentre il carico sui server è alto. Un valore alto significa un comportamento più aggressivo, un valore basso è più apprezzato.

Vedi:

User-Agent header
Usa un  header descrittivo che includa il nome della tua applicazione e, nel caso, anche un tuo indirizzo e-mail. Non copiare semplicemente l'user-agent di un browser web popolare (a meno che il tuo client delle API non sia un'applicazione JavaScript eseguita dal suddetto browser web tramite Ajax, in questo caso uno non può modificare l'user-agent.) Questo fa sì che laddove emerga un problema sia facile tracciare da dove provenga. Vedi API:Main page/it#Identificare il tuo client e m:User-Agent policy per dettagli.

Pensare alle performance in generale
Se stai cercando di scoprire come mai stai ottenendo risultati in modo più lento rispetto a come vorresti, prova per pensare alle performance in generale. Se stai scoprendo che la lettura tramite API piuttosto che tramite lettura diretta ai database sta impedendo le performance del tuo client, considera se sia il caso di inserire il tuo tool in Wikimedia Toolforge.