タグ

jsonschemaに関するymm1xのブックマーク (25)

  • JSON Schema Generator

    A JSON Schema generator

    ymm1x
    ymm1x 2015/07/24
    JSON -> JSON Schema 生成
  • Qiita API v2のJSON Schemaを公開しました - Qiita Blog

    こんにちは、r7kamura です。 最近は主にイカとして活動しており、カラフルな墨を掛け合う日々を送っています。 さて、QiitaおよびQiita Teamでは、Qiita API v2としてデータを操作するためのREST APIを公開しています。これまで開発者向けに APIドキュメント を提供していましたが、今回は主に機械向けのインターフェースとして、JSON Schemaで記述したREST APIのスキーマ定義 (以下スキーマ) を公開することになりました。具体的には、JSON Hyper-Schema draft v4 を利用して定義されています。 http://qiita.com/api/v2/schema Qiita API v2のスキーマの説明Qiita API v2のスキーマの構成について簡単に説明します。スキーマは http://qiita.com/api/v2/sche

    ymm1x
    ymm1x 2015/07/24
    ✘╹◡╹✘
  • Web APIのためのJSON Hyper-Schema - Tbpgr Blog

    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

    Web APIのためのJSON Hyper-Schema - Tbpgr Blog
  • APIドキュメントを実装と乖離させないために - Qiita

    内部用APIであるか外部の開発者向けのAPIであるかに関わらず、ドキュメントと実装との乖離は極力避けたいものであるが、注意深く開発を進めない限りこの状況は容易に起こり得る。何が乖離を引き起こし、どうすればこの状況を回避できるのか考えながら、JSON Schemaの利用例を紹介する。なおこの投稿では、HTTP経由でデータの通信を行うような狭義のAPIのことをAPIと呼ぶことにする。 同じ情報源を参照する APIドキュメントと実装が同じ情報源を参照するようにすれば、論理的に関連した要素は統一的に変更され、これらの変更は完全に同期が取れたものになる。つまり、変更時に乖離が生じにくくなる。但し情報の見せ方によって乖離が発生する可能性は十分にだろうし、乖離が発生するのは理解しようとする側の認識の問題であるから、論理的に全く起こり得ないということではない。 この参照の形には、両者が別の情報源を参照する

    APIドキュメントを実装と乖離させないために - Qiita
  • JSON SchemaとPHP

    というタイトルで発表してきました。Engine Yardさま、いつも会場提供ありがとうございます。 ( 第72回 PHP勉強会@東京 : ATND ) JSON Schemaというものがあって、すげー応用範囲が広くて、バリデーションなら大体これだけで出来ますよーという内容でした。 スライドはちょっとネタに走ってますが、書いてあることは割と気です。「JSON SchemaはJSONのバリデーションを行うためのもの」と一般には定義されていますが、JSON互換のデータ構造を持っている動的型付き言語においては、JSON Schemaで言語ネイティブのデータ構造が全てバリデーションできてしまうのです。 JSON Schemaはいまひとつ流行ってない気もしますが、構造そのもののバリデーションに主眼を置いていたり、言語を超えてバリデーションルールを共有できたり、結構おもしろいことができるので、使ってみ

    JSON SchemaとPHP