MediaWiki API ヘルプ

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

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

action=opensearch

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

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

パラメーター:
その他一般パラメーターが利用可能です。
search

検索文字列。

この変数は必須です。
namespace

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

値 (| または別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、100、101、102、103、126、127、710、711、828、829
すべての値を指定するには、*を用いてください。
既定: 0
limit

返す結果の最大数。

型: 整数または max
値は1以上500以下です。
既定: 10
profile

使用するプロファイルを検索します。

strict
いくつかの句読点記号を取り除き発音区別記号やアクセント記号を保持した厳密なプロフィール
normal
いくつかの句読点記号、発音区別記号と検索対象外単語は取り除かれている。
fuzzy
通常動作に加えタイプミスの訂正(2つのタイプミスまでに対応)を行う。
fast-fuzzy
実験的なあいまいプロフィール(いつでも削除可能)
classic
いくつかの句読点記号と発音区別記号を取り除いた伝統的な接頭辞
engine_autoselect
検索エンジンの最適なプロフィールの選択をお任せください。
値 (次の値のいずれか1つ): classic、engine_autoselect、fast-fuzzy、fuzzy、normal、strict
既定: engine_autoselect
suggest
廃止予定です。

使われなくなりました。

型: 真偽値 (詳細)
redirects

転送を処理する方法:

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

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

値 (次の値のいずれか1つ): resolve、return
format

出力する形式。

値 (次の値のいずれか1つ): json、jsonfm、xml、xmlfm
既定: json
warningsaserror

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

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