MediaWiki API ヘルプ

このページは自動生成された MediaWiki API の説明文書ページです。

説明文書と例: https://www.mediawiki.org/wiki/API

action=opensearch

(main | opensearch)
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • ライセンス: GPL-2.0-or-later

OpenSearch プロトコルを使用してWiki内を検索します。

パラメーター:
search

検索文字列。

このパラメーターは必須です。
namespace

検索する名前空間。searchが有効な名前空間接頭辞で始まる場合は無視されます。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、202、274、275、828、829、2300、2301、2302、2303
To specify all values, use *.
既定値: 0
limit

返す結果の最大数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
suggest

$wgEnableOpenSearchSuggest が false の場合、何もしません。

Type: boolean (details)
redirects

転送を処理する方法:

return
転送ページそのものを返します。
resolve
転送先のページを返します。limit より返される結果が少なくなるかもしれません。

歴史的な理由により、format=json では "return" が、他の形式では "resolve" が既定です。

値 (次の値のいずれか1つ): returnresolve
format

出力する形式。

値 (次の値のいずれか1つ): jsonjsonfmxmlxmlfm
既定値: json
warningsaserror

If warnings are raised with format=json, return an API error instead of ignoring them.

Type: boolean (details)
例:
Te から始まるページを検索する。
api.php?action=opensearch&search=Te [サンドボックスで開く]