ITエンジニア/デザイナ向けにオープンソースを毎日紹介

Web APIが多く使われるようになると、その品質が求められるようになります。様々な要素があるでしょうが、まず大きいのはドキュメント通りに作られるかどうかの確認でしょう。そのために使えるのがJSON Schemaです。

XMLでもSchemaはありましたが、JSONでもついにSchemaが必要になるかも知れません。そんなJSON Schemaを使って値のサンプルだけを抜き出せるのがScreijiです。

Screijiの使い方

ScreijiはRubygemsを使ってインストールします。

$ gem install screiji

インストールしたらJSON Schemaを使って試してみます。今回は次のような内容です。

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "foo": {
      "type": "string",
      "example": "foo string"
    }
  }
}

これをScreijiで実行すると次のように表示されます。

puts Screiji.example(JSON.parse(json_schema))
=> {"foo"=>"foo string"}

Screijiを使うことでWeb APIを利用する際のサンプルになる値が表示できるようになるでしょう。単純にコードの中で使うだけでなく、こういった開発者にとって役立つものが作れるようになるとJSON Schemaの利用も広まるのではないでしょうか。

ScreijiはRuby製、MIT Licenseのオープンソース・ソフトウェアです。

gin0606/screiji

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2