みなさんjson schema利用していますか? webAPIのスキーマテストをjson schemaを利用して行っているので、実装時に利用した機能のちょっとしたメモを公開します。 properties オブジェクト(連想配列)の唯一の名前を指定できる 値が一つだけの場合はこれを用いると楽
2016年1月5日現在において、JSONを受け取り、返却するWeb APIを書くときに、人が作った規格に乗って楽をしようぜと考えた。 その過程で調べた、JSON Schemaについてメモ書き。間違ってたらツッコミよろ。 概要 JSONの構造を記述する規格。構造の記述そのものもJSONで書かれる。 Draft v4現在では、JSON Schemaは以下の3つの規格の総体を指す。 JSON Schema Core JSON Schema Validation JSON Hyper-Schema そもそも提案された初期のJSON Schemaは、JSON Schema Core+JSON Schema Validationとほぼ同じ領域をカバーしていた。整理・発展の上3仕様に分割された。よって、JSON Schema Core+JSON Schema Validationにあたるものを単にJSO
JSON SchemaでAPI開発を自動化する Tweet このエントリは弊社の英語ブログのAutomating your API with JSON Schema — Commerce Hack の翻訳です。 APIのドキュメントとクライアントライブラリの保守には苦労します。時間もかかるし、ドキュメントの更新をついつい忘れてしまうこともよくあります。私たちは、こういう作業をするのにいいツールはないものか、ずっと探していました。 そして見つけたのが JSON Schema です。これは本当にクールな技術で、私たちはこれを、APIのドキュメント生成、クライアントライブラリ内のロジック、そして自動化テストの中で活用しています。ここではその活用法を紹介したいと思います。 JSON Schema とは何か? JSON Schema とは、JSON object の記述と検証のための標準で、概略はこ
JSON Schema ってどこにどうやって置いて管理したらいいの? prmd の README にある File Layout の項で、JSON Schema のオススメのファイル構成について言及されていたので、積極的に真似していくスタイルがヨサソウです。 /docs # top-level directory for project documentation /schema # API schema documentation /schemata /{resource.[json,yml]} # individual resource schema /meta.[json,yml] # overall API metadata /overview.md # preamble for generated API docs /schema.json # complete generate
Ruby Business User Conference 2015での発表資料です。
JSONスキーマと、RubyでJSONスキーマつかってvalidationするやり方を解説します。 全てがJSONになる - ✘╹◡╹✘ を読んでJSON schema良さ気だと思ったけど、まだ使ったことない人向けの記事です。 JSONスキーマって? 本屋のJSONデータを返すAPIがあったとします。 { "name": "おしゃれな本屋", "place": { "large_area": "おしゃれな地域", "small_area": "おしゃれな街", "address": "おしゃれな街のおしゃれな建物", "latitude": 33.333, "longitude": 33.333 } } これに対して、JSONスキーマを用意しておけば、1つ1つの値の有無や型をチェックできます。生成したJSONが意図したものになっているかテストするのに便利です。 JSONスキーマといいつつJ
JsonWorldというGemを使って、JSON Schemaを生成できるモデルクラスをつくります。Qiita API v2のJSON Schemaを公開しました - Qiita Blog の裏側で使っているやつです。 JsonWorldの使い方 JsonWorld::DSL というModuleが提供されているので、これを任意のClassにincludeします。このmoduleをincludeしたClassでは、以下の特異メソッドが利用できるようになります。propertyとlinkを利用してインターフェースを定義し、to_json_schemaでJSON Schemaとしての表現を取り出す、というのがJsonWorldの使い方です。 .property(property_name, options) .link(link_name, options) .to_json_schema Js
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました JSONがWeb APIのデータ送受信フォーマットとして活用されるようになると、受け取る側と発信する側でその内容が適切であるかどうか検証する手段が必要になります。それがJSON Schemaです。 2009年頃に登場したようですが、当時は面倒がってあまり使われてきませんでしたが、JSONの普及ともとに注目が集まっています。そんなJSON Schemaを開発者にも優しいフォーマットに変換してくれるのがJdocです。 Jdocの使い方 JdocはRubygemsからインストールできます。 $ gem install jdoc 使い方としてはjdocコマンドにスキーマのパスを渡すだけです。 $ jdoc spec/fixtures/schema.yml # Example API * [
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く