本文へ移動

データベースを起点にAPI契約を生成

データベースを起点に、OpenAPI、44,076行の型付きTypeScriptクライアント、61個のモックハンドラー、UIが適用する制限を生成し、各段階に不一致で失敗する検査を設けた。

44,076 DBから生成する型付きクライアントの行数

状況. フロントエンドとバックエンドは別々の速度で進み、リクエストのペイロードへの想定が、気づかないうちに食い違うことがある。通常は、不一致を公開したあと、ブラウザーの422応答で初めてわかる。最も修正費用が高い時点だった。同じ文書から両側を手で書いても、文書を読み直し忘れた人へ不一致の発生場所が移るだけだった。

課題. 両側で合意するのでなく単一の情報源から生成し、生成の各段階を信頼任せにせず検証する必要があった。

行動. 生成の連鎖をデータベースから外へ伸ばした。スキーマと関数が構造を、Goの型がAPIを定義し、HumaがOpenAPIを出力する。その記述から44,076行の型付きTypeScriptクライアントを生成し、61個のモックハンドラーも生成した。フロントエンドのテストは手書きの固定データではなく実際のAPI仕様に従う。フォームが適用する制限も検証器へ再入力せず、同じ場所から取得する。各段階に検査を設けた。CIで送信内容とAPIの期待値を比較し、不一致でビルドを止め、その下には記述でなく実際の構造を調べるスキーマ検査を置いた。特に「未指定」と「null」を混同しやすい任意の本文項目と、許容値が静かにずれやすいクエリ引数の列挙値を対象とした。

結果. 片側だけの項目変更は、気づいた最初の段階で、変更後数分のビルド中に失敗する。レビューでは見えず、実行時にしか現れなかった反復的で厄介なバグを除去した。代償は途中の再生成作業であり、連鎖の信頼性は最も守りの弱い箇所までしかない。そのため、各段階に検査を設けた。

  • 空いた部分のそばにあるジグソーパズルのピース
    写真: 422737 / Pixabay
  • 色とりどりのジグソーパズルのピース
    写真: rkit / Pixabay

この経験をお客様のプロジェクトに

「データベースを起点にAPI契約を生成」を、お客様の組織の似た課題を考える出発点にしてください。この実績を支えたサービスを、お客様のプロジェクトにも提供できます。 変更を検証し、リリースし、元に戻せる仕組みを整え、金曜の深夜ではなく火曜の午後にお客様へ届けられるようにします。

サービスを見る お問い合わせ

結果の背景を確かめる

この事例の状況、判断、結果をご覧ください。どの部分がお客様の制約の下でも生かせるか、どこに別の方法が必要かをご相談いただけます。 データベースを起点にAPI契約を生成 — 44,076 DBから生成する型付きクライアントの行数

サービスを見る お問い合わせ

より多くの実績の 一つです — そのすべてをこのサイトで公開しています。

どの項目も、状況、課題、実施内容、変化という同じ構成で記載しています。

すべての実績を見る

必要な改善を定める

デプロイの流れ、運用上のリスク、緊急対応の担当者をお知らせください。検査、復旧手段、明確な責任の所在を伴う変更の範囲を定められます。

料金を見る お問い合わせ

フロントエンドとバックエンドが食い違っていませんか?

「データベースを起点にAPI契約を生成」の判断の背景についてお尋ねください。仕事内容を説明し、お客様のプロジェクトを検討できる担当者が対応します。

サービスを見る
welcome@engineer.company +45 50 10 61 84 デンマーク、コペンハーゲン
データベースを起点に、OpenAPI、44,076行の型付きTypeScriptクライアント、61個のモックハンドラー、UIが適用する制限を生成し、各段階に不一致で失敗する検査を設けた。のQRコード
このページを持ち歩くhttps://platform.engineer.company/ja/portfolio/generated-the-api-contract-from-the-database-out/