API:エチケット

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

Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎dansk • ‎español • ‎français • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎فارسی • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어
このページでは作業が進行中です。

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

ヘルプ

  1. この「よくある質問」をお読みください
  2. あなたの質問への回答をこちらの API 説明文書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 system administrators 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 are never making more than one request at the same time), then you should definitely be fine.

一度のリクエストにまとめられる場合はできるだけまとめてください (例: ページ名ごとにリクエストを実行する代わりに titles パラメーターに複数のページ名を指定する。Or use "ジェネレーター" if possible instead of making a request for each result from another request)

版の構文解析

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


maxlag パラメーターの使用

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

以下を参照してください: Manual:maxlag パラメーター


User-Agent ヘッダー

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

Thinking about performance generally

If you are trying to figure out why you are getting results more slowly than you would like, try Performance guidelines 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 Toolforge.