mindiaAPI

3pt

すごく書きかけ、ちょいちょい更新。

要望New!

下記に九龍個人の想定するmindiaAPIの具体的な要望を記載しておきます。

API形式

APIの形式はREST形式、理由としては「シンプルで簡単に利用可能」という利点があるから。
まずは開発者にどんどん使ってもらってmindia関連アプリケーションを増やすのが認知に広がると思う。

APIの基本

URL：http://api.mindia.jp/（関数）.（取得フォーマット）?（キーワド）=（値）
(1)URLはhttp://mindia.jp/api/
(2)関数はsearchやeditなど具体的なAPI機能別に表記
(3)取得フォーマットはJSON形式とXML形式を選択出来る
(4)キーワードは関数に関連するモノ、検索なら検索キーワードをkeywordとしたり
(5)値は各キーワードに代入する値

API取得データ

JSONデータの場合
{
　results[
　　{
　　　user：(ユーザ名)
　　　userImg：(ユーザ画像)
　　　userURL：(ユーザマイページURL)
　　　userBook：(ブック名)
　　　keyword：(キーワード名)
　　　snippet：(スニペット)
　　　text：(本文)
　　　tags：(タグ)
　　　date：(作成日)
　　　update：(更新日)
　　}
　]
　keyword：(検索キーワード)
　total：(検索合計数)
　count：(取得数)
　page：(取得開始位置)
}

resutls[]に各検索結果を格納、全体情報を下っつらに格納。
totalはページャー実装時に必須な感じなのであった方が良い。

API各種（各例はJSONの場合）

(1)キーワード検索
URL：http://api.mindia.jp/search.（取得フォーマット）?keyword=（値）
機能：mindia全体からキーワードにマッチしたモノを検索する
使用例：
http://api.mindia.jp/search.json?keyword=mindia
「mindia」にマッチするキーワードを検索する

(2)ユーザ検索
URL：http://api.mindia.jp/search.（取得フォーマット）?user=（値）
機能：mindia全体からユーザにマッチしたモノを検索する
使用例：
http://api.mindia.jp/search.json?user=kowloon
「kowloon」にマッチするキーワードを検索する

(3)昇順降順検索
URL：http://api.mindia.jp/search.（取得フォーマット）?keyword=（値）&sort=（値）
機能：mindia全体からキーワードにマッチしたモノを昇順降順で検索する
備考：sort=nameにすれば名前順、sort=pointにすれば評価順など
使用例：
http://api.mindia.jp/search.json?keyword=mindia&sort=poi...
「mindia」にマッチするキーワードを評価順で検索する

記事

「mindiaAPI」は非公式に九龍が勝手に呼んでいるだけの物です。

※mindiaはJSON形式をサポートしているそうです（西小倉辞典）。

取得例：
http://mindia.jp/?module=book_keyword_json&book=nishiko
サンプル：
http://nishikokura.com/
PHPでkeywordを取得したコードを返す(JSON）→jQueryでランダムに表示、という流れ。多分。

※パラメータ（調査中）

module=book_keyword_json

の部分が機能（module）の指定、keywordとかもあるっぽい？

book=nishiko

ブックの指定、検索対象等々を指定する言わばオプション的位置。

Web3.0時代のWebサービスはDB蓄積をユーザーに任せる時代からサービスの拡張も任せる時代に変位しているので、今後のMindiaAPIの拡張、公開にひっそりと期待。