Web APIのためのJSON Hyper-Schema

Web APIのためのJSON Hyper-Schemaについて

2015/08/05追記。DeNAの清水直樹さんのスライドを追加しました

JSON Hyper-Schemaについて

下記を参照

JSON Schema Official

必要性

• APIの運用にはAPIドキュメントが必要
• APIの実装とドキュメントの差異をなくす必要がある
• JSON Hyper-Schemaを活用することで以下のようなメリットがある
  • DSL等で作成したクラスを元にJSON Schemaを生成することでコードとSchemaの整合性がとれる
  • Schemaを元にAPIドキュメントを生成することができる
  • Schemaを元にValidationが可能になる
  • Schemaを元にClientアプリケーションの自動生成できる

スライド

GMOペパボの高橋健一さん

DeNAの清水直樹さん

JSON Schema と API テスト YAPC::Asia Tokyo 2014 from Naoki Shimizu

サンプル

QiitaのAPI(v2)がJSON Schemaを公開しています。

"Qiita API v2 JSON Schema

Web API と JSON Schemaに関わるツールについて

下記エントリを参照

tbpgr.hatenablog.com

外部資料

• JSON Schema Official
• JSON Schema Core+Hyper spec v4の理解に読んで役に立ったリンク - Qiita
• JSON Schemaを上手く運用出来そうなprmdとその周りのお話 - Qiita