本文へ移動

APIを100%の一致でHuma v2へ移行

HTTP APIの649パス・760操作をFiberからHuma v2へ移行し、サーバーが登録するルートと公開するOpenAPI記述の100%一致を達成・維持した。

760 移行し記述の整合性を保ったAPI操作

状況. APIはFiberで始まり、エンドポイントごとにリクエスト検証を手書きしていた。少数ならよくても、増えるにつれ保守負担となり、各実装が独自であるため小さな不一致が入り込んだ。API全体の構造を表す単一の記述もなかった。

課題. 全面的な一括書き直しのために止まることなく、手書き検査の代わりに型から検証を生み、APIの構造を記述する仕様を得ることが目標だった。

行動. 既存ランタイムを保ち、Fiber上のHuma v2へHTTP層を移した。各エンドポイントに入力・出力構造体を設け、型からHumaが検証と応答モデルを生成する。OpenAPI記述も自動で得られ、wikiで古くなるのでなくコードに追随する。新規はすべてHumaで書き、既存も移行した。ただし、ソケット自体が必要でリクエスト・応答モデルに合わないWebSocketの2エンドポイントだけを、生のFiberに残した。規模は649パス・760操作となり、実際の登録ルートとOpenAPIが公表するルートをCIで比較する。未記述ルートがビルドを失敗させるため、一致率100%を維持する。

結果. 追加作業なしで新規エンドポイントに検証と最新文書が備わり、項目の検査忘れのようなリクエスト処理バグの一群がなくなった。760操作では、APIを読む実用的な手段は記述しかなく、完全性の保証は50操作だったころ以上に重要だった。型によって期待する入力を伝えるAPI仕様によって、安全に変更でき、人に引き継ぎやすいAPIとなった。

  • 線路の分岐点
    写真: music4life / Pixabay
  • 折り畳み地図、道路地図、旅程
    写真: cocoparisienne / Pixabay

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

「APIを100%の一致でHuma v2へ移行」を、お客様の組織の似た課題を考える出発点にしてください。この実績を支えたサービスを、お客様のプロジェクトにも提供できます。 まず全体像を設計し、各部分のつながりと費用を、コードを書き始める前に明らかにします。

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

結果の背景を確かめる

この事例の状況、判断、結果をご覧ください。どの部分がお客様の制約の下でも生かせるか、どこに別の方法が必要かをご相談いただけます。 APIを100%の一致でHuma v2へ移行 — 760 移行し記述の整合性を保ったAPI操作

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

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

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

すべての実績を見る

必要な改善を定める

業務の流れ、既存のインターフェース、変更を必要とする利用者をお知らせください。検証可能な納品内容と、お客様のチームが保守を続けられる引き継ぎ内容を定められます。

料金を見る お問い合わせ

入力を検証し、文書も整ったAPIが必要ですか?

「APIを100%の一致でHuma v2へ移行」の判断の背景についてお尋ねください。仕事内容を説明し、お客様のプロジェクトを検討できる担当者が対応します。

サービスを見る
welcome@engineer.company +45 50 10 61 84 デンマーク、コペンハーゲン
HTTP APIの649パス・760操作をFiberからHuma v2へ移行し、サーバーが登録するルートと公開するOpenAPI記述の100%一致を達成・維持した。のQRコード
このページを持ち歩くhttps://engineer.company/ja/portfolio/migrated-the-api-to-huma-v2-at-100-parity/