共通仕様

個々の辞書により仕様が異なることもあるが、原則としては以下の通りである。

リクエストURL

  1. リスト取得

    http://ircdict.aa-ken.jp/dictname/searchext?q=word

    検索語に前方一致する語のリストを取得する。

    パラメーター説明
    dictname辞書名
    ext *拡張子(.json/.jsonp/.xml/.html; default: .json)
    word検索語(前方一致)
  2. 解説取得

    http://ircdict.aa-ken.jp/dictname/entries/wordext[?fields=fields]

    対象となる語の解説を取得する。

    パラメーター説明
    dictname辞書名
    word対象となる語(完全一致)
    ext *拡張子(.json/.jsonp/.xml/.html; default: .json)
    fields *取得するフィールドを comma 区切りで指定

レスポンス

ext に応じた形式のデータを取得できる。

形式説明
.jsonJSON(JavaScript Object Notation)
.jsonpJSONP(JSON with Padding); クエリーパラメータ callback=callback によりコールバック関数を指定。
.xmlXML; root node: <result>
.htmlHTML; 現状シンプルな形のみ。辞書ごとに登録された Template を利用(未実装)
キー/要素説明
dict辞書名
versionversion 情報(原則として登録日)
copyright著作権情報
resレスポンスデータ; 各辞書による。

辞書の登録

登録に必要な情報は以下の通りである。現時点では JavaScript/CoffeeScript 等の連想配列。応相談です。

項目説明
name辞書名
versionversion 情報(原則として登録日)
copyright著作権情報
url自身で公開する辞書データベースのトップページ URL
encoding上記辞書サイトの encoding
idbase辞書項目を独自 ID で管理している場合 true, そうでなければ false
allowListWithoutMatch検索語と前方一致する項目のリストの取得を容認する場合は true, そうでなければ false
searchリスト取得に利用される連想配列; 下記参照
show解説取得に利用される連想配列; 下記参照

search

項目説明
uriリスト取得用 URI
methodGET or POST
paramsパラメーター
parse辞書サイトから取得した HTML 用パース関数

show

項目説明
uriリスト取得用 URI
methodGET or POST
paramsパラメーター
fields出力されるフィールド名の連想配列
defaultFieldsデフォルトで出力するフィールドの配列; false ですべてのフィールド
parse辞書サイトから取得した HTML 用パース関数
fieldsRev辞書サイトで使用される項目名からフィールド名への連想配列

Copyright © 2014 by IRC/ILCAA.
All rights researved.