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

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

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

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

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

カテゴリー:
1バックエンド開発	/ja/categories/backend/	platform.engineer.company	70
1API・システム連携	/ja/categories/api/	platform.engineer.company	70
1DevOps	/ja/categories/devops/	platform.engineer.company	70
1自動化・CI/CD	/ja/categories/automation/	platform.engineer.company	70
1信頼性・バックアップ	/ja/categories/reliability/	platform.engineer.company	70
1テスト・品質保証	/ja/categories/testing/	platform.engineer.company	70

サービス:
1バックエンド・API開発	/ja/services/backend-development/	platform.engineer.company	70
1AIエージェント用ツール・MCPサーバー	/ja/services/ai-tools/	platform.engineer.company	70
1DevOps・CI/CD自動化	/ja/services/devops-cicd/	platform.engineer.company	70

hこのページのウェブ版	URL:https://platform.engineer.company/ja/portfolio/generated-the-api-contract-from-the-database-out/	platform.engineer.company	70
