Tbpgr Blog

Ruby プログラマ tbpgr(てぃーびー) のブログ

Web APIのためのJSON Hyper-Schema

f:id:tbpg:20150721222819j:plain

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の清水直樹さん

サンプル

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

"Qiita API v2 JSON Schema

Web APIJSON Schemaに関わるツールについて

下記エントリを参照

tbpgr.hatenablog.com

外部資料