Contributor向けメモ

[marihachi]

よく分からない点などあれば分かる範囲で書きます

• collectionのコンストラクタにconfigを渡すのでこれを一時的に書き換えることで対象のdbをすり替えることが可能です (テスト時はこの方法で対象のdbを変更しています)
• DocumentModelsには静的アクセス可能なユーティリティがあります
• 直接的なdocument内容はDocumentModelsのインスタンスの.document以下に配置してあります
• routesディレクトリ下はrouteList.jsに定義してあるエンドポイントに沿って構造化されています
  POSTなどのhttpメソッドがそれぞれrouteモジュールのメソッド名になっています。
• documentへの操作はDocumentModelsが行うべきで、routesの肥大化を防ぐためにもroutesからの直接的なdb操作は減らしていきたい
• リクエストはX-Api-VersionヘッダによってAPIバージョンを明示的に指定させるようにします

ポストの種類

• Status
  短文の投稿記事
• Article
  ブログ記事のように長文を入力可能(記事タイトルを設定可能)
• Reference
  投稿の共有に利用される投稿

ストリーミングAPI

WebSocketプロトコルに従って接続してください。

タイムライン接続リクエストの例
{"type":"timeline-connect","data":{"type":"home"}}
レスポンス
{"type":"timeline-connect","data":{"success":true,"message":"connected home timeline"}}

クエリ文字列

• application_key (必須)
• access_key (必須)
• access_token (必須)

サポートされているリクエストイベント 一覧

rest リクエスト

ストリーム上からのREST APIへのアクセスをサポートする

パラメータ

• method (必須): HTTPメソッド名
• endpoint (必須): エンドポイント
• query: クエリ文字列
• body: リクエストボディ

timeline-connect リクエスト

ストリーミングタイムラインと接続する

パラメータ

• type (必須): タイムラインの種類。例) public、home

timeline-disconnect リクエスト

ストリーミングタイムラインから切断する

パラメータ

• type (必須): タイムラインの種類。例) public、home

[marihachi]

Streaming APIの仕様が変更されました。Socket.io -> WebSocket

[marihachi]

情報が古い