API:Etiquette/ja

'''このページでは作業が進行中です. '''

クイック スタート ガイドもお読みください. このページで回答していない質問にも回答しており、その他の有用なページヘのリンクもあります.

ヘルプ

 * 1) この「よくある質問」をお読みください.
 * 2) あなたの質問への回答をこちらの API 説明文書または API 自身が生成した API ホームページでお探しください.
 * 3) あなたの質問への回答がウェブ上で見つからない場合は、mediawiki-api メーリング リストでお尋ねください.

リクエストの上限
There is no hard and fast limit on read requests, but we ask that you be considerate and try not to take a site down. Most sysadmins reserve the right to unceremoniously block you if you do endanger the stability of their site.

If you make your requests in series rather than in parallel (i.e. wait for the one request to finish before sending a new request, such that you're never making more than one request at the same time), then you should definitely be fine. Also try to combine things into one request. For example: specify multiple '|'-separated titles in a  parameter instead of making a new request for each title; use a "generator" instead of making a request for each result from another request.

版の構文解析
版番号を指定して結果を取得するクエリを実行することもできますが、これはサーバーにとって負荷が高い処理です. 'oldid' パラメーターを使用して特定の版を取得するには、例えば以下のようにします:


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

maxlag パラメーターの使用
タスクが対話的ではない場合 (つまり、利用者が処理結果を待機しない場合) は、maxlag パラメーターを使用すべきです. これにより、サーバーの負荷が高い場合に、タスクの実行を防止できます. Higher values mean more aggressive behavior, lower values are nicer.

以下を参照してください:

User-Agent ヘッダー
Use a descriptive  header that includes your application's name and potentially your email address if appropriate. 人気があるウェブ ブラウザーの User-Agent をコピーしないでください (あなたの API クライアントが、ウェブ ブラウザーで Ajax を使用して動作する JavaScript アプリケーションである場合を除きます. この場合は User-Agent を変更できないためです). これにより、問題が発生した場合に発生源を特定するのが容易になります. 詳細は API:Main page#Identifying your client と m:User-Agent policy を参照してください.

Thinking about performance generally
If you are trying to figure out why you are getting results more slowly than you would like, try to help you think about performance generally. If you are finding that reading via the API rather than directly reading from databases is impeding your client's performance, consider whether to put it into Wikimedia's Tool Labs.