コンテンツへスキップ
uencoder

SIREN

SIREN は、actions・links・entities によって実行可能な操作とサブリソースを JSON で表現するハイパーメディア形式である。フォームとフィールドをサポートする。

目的

REST API に実行可能な(GET 以外の)操作を備えたハイパーメディア表現を与え、クライアントが POST/PUT/DELETE 操作を発見できるようにする。

メカニズム

エンティティは actions(name・method・href・fields・type を持つ操作の配列)、links(ナビゲーションリンク)、entities(サブリソース)を含む。クライアントはアクション名で操作を発見して実行する。

ユースケース

  • REST ハイパーメディアのアクション発見
  • 動的なフォーム生成
  • API ワークフロー

関連ツール

References