Skip to content

03.10.02.MessagePack

Akinori Yamada edited this page Jan 8, 2015 · 3 revisions

データファイルを用意するだけで、MessagePackのバイナリデータをレスポンスすることができます。ただし、テンプレートエンジンとの共存はできません。

project.yaml

project.yamlのmessagepackを設定すると、MessagePackのデータをレスポンスすることができます。

messagepack.root

MessagePackのレスポンスとして利用するデータファイルのルートディレクトリです。プロジェクトルートからの相対パスを指定します。

messagepack:
  root: ./messagepack/data
messagepack.mode

project.yamlのmodeにはjsonモード(デフォルト)とcompactモードがあります。jsonモードであれば、クライアント側でそのままjsonにデシリアライズできます。

クライアントでデシリアライズ用のオブジェクトがある場合は、compactモードが利用できます。compactモードはjsonモードよりデータ量は少ないです。

messagepack:
  root: ./messagepack/data
  mode: json

データファイルの仕様

基本的に、テンプレートデータファイルの仕様はJSON APIのデータファイルと同じです。

Clone this wiki locally