#author("2019-09-04T07:18:11+09:00","","")
[[FrontPage]]
&size(24){データAPI/SIMWORD検索}; (サジェスト検索)
* API情報 [#q6190828]
|~名称|SIMWORD検索|
|~APIバージョン|2|
|~認証タイプ|なし|
|~URL|https://(APIサーバー名)/services/api2/(アクセスコード)/simword/{simple,partial}/json/検索語/|
|~Method|GET|
|~データ更新頻度目安|4週間|
* 概要 [#jfe13a2c]
入力文字列に近接する語を検索する。&br;
* アクセス手順 [#ya59d11f]
** クエリー [#l9016c71]
https://(APIサーバー名)/services/api2/(アクセスコード)/simword/simple/json/(検索文字列)/ &br;
(検索文字列) で検索した結果を返却する。検索は先頭一致で実施される。
https://(APIサーバー名)/services/api2/(アクセスコード)/simword/partial/json/(検索文字列)/ &br;
(検索文字列) で検索した結果を返却する。検索は部分一致で実施される。
検索文字列がマルチバイトの場合は、文字コードをUTF-8としURLエンコードを施したものとする。&br;
検索文字列は1文字以上6文字以内とする。&br;
** 入力される検索文字列の取り扱い [#u55567aa]
入力された検索文字列は、全部分が採用され、切り捨てはない。&br;
** クエリー例 [#ea78dac9]
https://(APIサーバー名)/services/api2/(アクセスコード)/simword/simple/json/%E3%83%8A%E3%82%B9/
https://(APIサーバー名)/services/api2/(アクセスコード)/simword/partial/json/%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3/
** レスポンス [#b7e56e30]
レスポンスコードは200を返し、レスポンスはjson形式である。レスポンスされる語の最大値は 10 である。
検索結果が存在しない場合は長さ0の配列が返される。クエリー書式誤り等の場合はレスポンスコード404が返される。
先頭一致の例
{
words :[
"ナス",
"ナスの煮浸し",
"ナスの煮物",
"ナス味噌炒め",
"ナス炒め",
"ナスの天ぷら",
"ナスカレー",
"ナス天",
"ナスの浅漬け",
"ナスの味噌汁",
]
}
部分一致の例
{
words :[
"ベビースターラーメン",
"野菜ラーメン",
"ラーメン丸",
"八番ラーメン",
"辛ラーメン",
"台湾ラーメン",
"ねぎラーメン",
"サッポロ一番味噌ラーメン",
"佐野ラーメン",
"和歌山ラーメン",
]
}
** レスポンス例 [#i994a280]
#html{{
<pre class="brush:xml;">
{
"words":[
"\u30ca\u30b9",
"\u30ca\u30b9\u306e\u716e\u6d78\u3057",
"\u30ca\u30b9\u306e\u716e\u7269",
"\u30ca\u30b9\u5473\u564c\u7092\u3081",
"\u30ca\u30b9\u7092\u3081",
"\u30ca\u30b9\u306e\u5929\u3077\u3089",
"\u30ca\u30b9\u30ab\u30ec\u30fc",
"\u30ca\u30b9\u5929",
"\u30ca\u30b9\u306e\u6d45\u6f2c\u3051",
"\u30ca\u30b9\u306e\u5473\u564c\u6c41"
]
}</pre>
}}
* 考慮事項 [#wa8c2055]
本APIの返却するデータは、クライアント側で適切にキャッシュ等を行い、アクセス量を低減させることで更に効率化されると考えられる。
* バージョン [#o0becc47]
このドキュメントのバージョン情報
|Version|1|
|Revision|1|
|Editor|west|
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
