会社のプロジェクトでサーバーサイド開発体験することになった。今まではスマホアプリ専門みたいな感じで、API使う側だった。

API使う側的な不満が結構あって、とりあえずドキュメントと実装の乖離は絶対に無くしたい絶対にみたいなモチベーションが生まれた。

なんかそういう感じのはいくつかあったけど、レスポンス自体の定義にはJSON Schemaを使おうという感じになった。ドキュメントはRAML使ってみようという感じで試してる。

JSON SchemaでAPIとドキュメントの乖離無くす手段として、実装からJSON Schema生成するのとかもある。

Qiitaで使ってる方法に乗っかるのはとても魅力的だったんだけど、プロジェクトの都合的に、ドキュメントとMockを取り急ぎ用意する必要があって、実装から生成するのはいろいろと辛そうかなと思って、一旦JSON Schema手書きすることにしたけどめっちゃ辛かった。

何が辛いって書くこと多いのが辛いし、なんかparserによってはファイルまたいだ$refを解決してくれないとかでarrayを"items": {"$ref": "hoge.json#definition/hoge"}みたいなのをやるのにめちゃくちゃ消耗した結果諦めた。

諦めたけどコピペで済ますのも大分辛いということで、yaml書いてJSON Schema生成するぞ！という感じにした。

prmdっていうgemがyamlでJSON Schema書いてJSON Schema生成してくれんだけど、結局書くのがJSON Schemaなので辛い！という感じだった。

ので雑にyaml書いて雑にJSON Schemaに展開してくれるgemを作った。

# foo.yaml
type: object
properties:
  foo:
    type: string
  bar:
    type: string
    optional: true # default value is `false`
  baz_list:
    type: array
    items:
      include: baz.yaml

# baz.yaml
type: object
properties:
  baz:
    type: string

という感じにfoo.yamlとbaz.yaml作って、

$ bundle exec schai --yaml foo.yaml --to foo.json

実行すると↓こんなJSON Schemaを生成してくれる。

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "foo": {
      "type": "string"
    },
    "bar": {
      "type": "string"
    },
    "baz_list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "baz": {
            "type": "string"
          }
        },
        "required": [
          "baz"
        ]
      }
    }
  },
  "required": [
    "foo",
    "baz_list"
  ]
}