JSON Schema や Ajv と TypeScript の型を紐づけるときの考え方や技術

2023/04/15 15 users TypeScript IDL Joi GraphQL Zod

宣伝 4/25 に Encraft #2 サーバーとクライアントを結ぶ技術 というイベントで JSON Schema について喋る。いま現在進行形で IDL として JSON Schema, GraphQL, Protocol Buffer, zod, joi を使っているのでそれらを食べ比べる発表をするつもりだ(明らかに JS 上でしか動かないものを IDL と呼んでいいか不安になってき... 続きを読む

JSON Schema で複雑な仕様の入力フォームの実装に立ち向かった話

2021/10/22 97 users 実装 仕様 入力フォーム

Transcript +40/�4DIFNB�Ͱ ෳࡶͳ࢓༷ͷೖྗϑΥʔϜͷ࣮૷ʹ ཱͪ޲͔ͬͨ࿩ ΫοΫύουגࣜձࣾ Ԙग़ ݚ࢙ 1 2 Ԙग़ ݚ࢙ ৯Ԙग़ݱ !TPMU���� ΫοΫύουגࣜձࣾ ങ෺ϓϩμΫτ։ൃ෦ ॴଐ ීஈ͸ 3BJMT�΍ 3FBDU�Λॻ͘ झຯ͸ϓϩτλΠϐϯάʢ࠷ۙ͸͓ֆඳ͖΋޷͖ʣ ҿञ TVEP�Λ๷ࢭ͢ΔγεςϜ 3 +40/�4DIFNB�Λ࢖࣮ͬͯݱͨ͠΋ͷ 4 ࢲ͕։ൃʹܞΘ͍ͬͯΔϓϩμΫτ ੜ઱৯඼Λத৺ͱͨ͠&$ϓϥοτϑΥʔϜ 5 ൢചऀ޲͚؅ཧը໘ • ঎඼৘ใͷొ࿥ • Ӧۀ೔ͷ؅ཧ • ग़ՙ࡞ۀͷ֬ೝ • ঎඼ϨϏϡʔͷฦ৴ 6 ൢചऀ޲͚؅ཧը໘ • ঎඼৘ใͷొ࿥ • Ӧۀ೔ͷ؅ཧ • ग़ՙ࡞ۀͷ֬ೝ • ঎඼ϨϏ... 続きを読む

JSON Schema をクックパッドマートの商品登録画面に導入した話 - クックパッド開発者ブログ

2021/04/06 104 users クックパッドマート クックパッド開発者ブログ ユーザ 開発

主にバックエンドのエンジニアとしてクックパッドマートの開発に携わっている塩出（ @solt9029 ）です。 美味しい食材をユーザにお届けするサービスであるクックパッドマートでは、日々街の販売店や地域の生産者が商品の登録を行っています。 商品を登録する際、販売者は消費期限をはじめとする様々な品質保証の情報を正... 続きを読む

TypeScriptの型定義からバリデーションコードを生成するツールを書いた | Web Scratch

2021/03/26 13 users TypeScript request response

create-validator-tsというTypeScriptの型定義からJSON Schemaを使ったバリデーションコードを生成するツールを書きました。 モチベーション expressなどでAPIを書くときに、Request/Responseが意図したものかどうかをバリデーションする必要があります。 特にreq.queryなどはStringが入ると予想しますが、オブジェクト... 続きを読む

JavaScript ベースの Vue.js プロジェクトのデータ構造を JSON Schema を使って守る - Qiita

2018/12/19 19 users Qiita TypeScript SPA Nuxt.js 言語

Vue.js で SPA を書く際、言語として JavaScript(ES) で書くか TypeScript で書くかは一つの悩みどころとなると思います。 私個人としては、 Vue.js プロジェクトでは多くの場合 TypeScript を、 Nuxt.js プロジェクトの場合は、 Nuxt.js がまだまだ TypeScript サポートが弱いことから、 JavaScript で書くようにしてい... 続きを読む

QuicktypeでJSON Schemaを簡単に生成し、型安全な最高の開発体験を得た話

2018/06/23 69 users QuickType 開発体験

動機 外界のデータに対して、どのように型付けを行うか - これは人類の当面の課題である。外界からアプリケーションに取り込んだデータに対して、内部で扱いやすいようにnon-nullの型を書くと、予期しないクラッシュを引き起こしてしまった、というような経験を誰しもお持ちではないだろうか。一方で、外界の状況と一致... 続きを読む

大コンテナ時代を生きのこるためのJSON Schema - Sexually Knowing

2017/12/08 49 users Sexually Knowing consul KVS バス

2017 - 12 - 08 大コンテナ時代を生きのこるためのJSON Schema 実行環境をコンテナ化するDockerが普及して久しく、CIやローカルの開発環境などどこかでコンテナ技術に触れているのではないでしょうか。 コンテナはその性質上、設定のプロビジョニングに古典的な設定ファイル (のパス) 受け渡しが難しいです。 etcd や consul のようなKVS (= Key- value ... 続きを読む

JSON Schema 中心設計 - FlowType から RAML まで - - Qiita

2017/09/19 90 users Qiita RAML Flowtype バリデーション API

はじめに Web サービスの運用を続けていくと，依存関係が徐々に複雑になっていきます．そしてメンテナンスするものが増えた結果，それらが相互に乖離していく，といったことが起こりがちです． そこで今回は，JSON Schema のみをメンテナンスしていくことで，動的チェック (バリデーション)，静的チェック (FlowType)，API ドキュメント生成，スタブ作成といった様々な恩恵を享受し，品質と保... 続きを読む

僕が考えた最強のAPIドキュメント生成 - 銀の人のメモ帳

2016/02/16 320 users 最強 メモ帳 request Rails JSON

2016 - 02 - 16 僕が考えた最強のAPIドキュメント生成 TL; DR ドキュメント生成には kevinrenskers/raml2html を使った ドキュメントは RAML - RESTful API modeling language で書いた RAMLには JSON Schema と JSON を記載できる API で返ってくる JSON は Rails アプリのrequest... 続きを読む

JSON Schemaでバックエンドエンジニアとフロントエンドエンジニアがコラボする / json-schema-collaboration // Speaker Deck

2015/12/08 82 users Speaker Deck フロントエンドエンジニア

JSON Schemaでバックエンドエンジニアとフロントエンドエンジニアがコラボする / json-schema-collaboration 続きを読む

JSON Schema書くのが辛くてgemを作った - 銀の人のメモ帳

2015/07/21 37 users gem 乖離 gin0606 ドキュメント モチベーション

2015-07-21 JSON Schema書くのが辛くてgemを作った gin0606/schaigithub.com 会社のプロジェクトでサーバーサイド開発体験することになった。今まではスマホアプリ専門みたいな感じで、API使う側だった。 API使う側的な不満が結構あって、とりあえずドキュメントと実装の乖離は絶対に無くしたい絶対にみたいなモチベーションが生まれた。 なんかそういう感じのはいくつ... 続きを読む

Qiita API v2のJSON Schemaを公開しました - Qiita Blog

2015/06/05 138 users Qiita Qiita API REST インターフェース

こんにちは、r7kamura です。 最近は主にイカとして活動しており、カラフルな墨を掛け合う日々を送っています。 さて、QiitaおよびQiita:Teamでは、Qiita API v2としてデータを操作するためのREST APIを公開しています。これまで開発者向けに APIドキュメント を提供していましたが、今回は主に機械向けのインターフェースとして、JSON Schemaで記述したREST ... 続きを読む

構造を定義したJSONを安全に扱うSwiftコードを自動生成する - Qiita

2014/12/07 25 users JSON Qiita Swift API 恩恵

はじめに Swiftで任意の形式のJSONを扱うには Swiftで面倒なJSONの取り扱いをさらに10倍便利にするclass JSON がかなり便利です。 しかし、大抵のAPIなどで得られるJSONは既に構造が決まっていて、そのやりとりやその後の処理を記述する部分では、可能ならば型安全の恩恵を受けたいと思うことがあります。 Json Schema というのはそういう方向性なのかもしれませんが、無駄... 続きを読む

Jdoc - JSON SchemaからAPIドキュメントを生成 MOONGIFT

2014/06/23 37 users MOONGIFT JSON APIドキュメント 生成 普及

JSONがWeb APIのデータ送受信フォーマットとして活用されるようになると、受け取る側と発信する側でその内容が適切であるかどうか検証する手段が必要になります。それがJSON Schemaです。 2009年頃に登場したようですが、当時は面倒がってあまり使われてきませんでしたが、JSONの普及ともとに注目が集まっています。そんなJSON Schemaを開発者にも優しいフォーマットに変換してくれるの... 続きを読む

全てがJSONになる - ✘╹◡╹✘

2014/06/09 1018 users JSON 書式 レスポンス APIサーバ APIクライアント

2014-06-10 全てがJSONになる TL;DR JSON Schemaを使ってこういうことが実現可能になった。 ダミーAPIサーバの提供 ドキュメントの自動生成 APIクライアントの動的定義 APIサーバのバリデータの動的定義 APIサーバのレスポンスの自動テスト JSON Schemaとは JSON SchemaというのはあるJSONのデータ構造を記述するための方法および書式の仕様で、 ... 続きを読む

HerokuのつくってるAPI関係の便利なやつ - ✘╹◡╹✘

2014/06/03 53 users Heroku API APIクライアント ヤツ 仕様

JSON Schema for the Heroku Platform APIでも紹介されているように、HerokuのAPIはJSON schemaで記述されたAPIの仕様を返すようなAPIがあって(ややこしい)、Auto-generating a Go API client for Herokuのようにこれを利用してAPIクライアントを自動生成するようなこともやってる(単なるアート作品じゃなくて... 続きを読む

Apiary - r7kamura per second

2014/02/13 88 users Swagger autodoc RAML Apiary API

API(とそれに携わる開発者)の規模が拡大してくると、ドキュメントの整備や、仕様と実装の一貫性の維持、 クライアントとの知識の共有など、考慮すべき問題が沢山出てくる。 これらの問題に対する現実的な解決策を探るため、 ApiaryというAPI開発支援用のサービスを簡単に俯瞰することにした。 ここでは紹介しないが、他に RAML、 JSON Schema、 Swagger、 WADL、 Autodoc... 続きを読む

JSON SchemaとPHP

2013/10/28 235 users PHP Hiraku Phalcon twitter.com

JSON SchemaとPHP Presentation Transcript JSON SchemaとPHP 第72回 PHP勉強会@東京 自己紹介 • 中野 拓 • https://twitter.com/Hiraku • http://blog.tojiru.net/ • PHP歴6年ぐらい • 最近使ってるフレームワークはYafとPhalconです • WebAPI関係のお仕事 • 最近コ... 続きを読む