てきとうなメモ

本の感想とか技術メモとか

Atomにするかどうか

Web APIのレスポンスのフォーマットを何にするか考えていて、とりあえずAtomにできるかどうかを検討していたのだが、何がなんでもAtomにしなくてはならない的な考え方は微妙な気がした。

Atomのメリットは

  1. 独自XMLよりはよく利用されているため利用者が既に知っている可能性が高い
  2. 既存のフィードリーダーやブラウザの機能で表示が可能
  3. 既存のライブラリやテストツールを利用可能

というところだと思う。でも、これらのメリットはAtomを大きく拡張したり、Atomに含まれる要素がメインのコンテンツでない場合はあまり大きなメリットにはならない。

また、Atomのentry要素はidとupdatedが必須なのでこれらの要素を出力していないとクライアントライブラリによってはparse時にエラーになる可能性がある。idについては一意に識別する何らかのURIを作り上げることはできそうなんだけども、updatedの場合は、更新日時が本質的に存在し得ないコンテンツだったり、更新日時はあるはずなのだがシステムが保存していなかったら(古いシステムにWeb APIを付加する場合など)はどうしようもない気がする。

今回の場合は上の2つに当てはまっているので独自XMLでいこうかなと