警告なしにAPIを破ると信頼を破る 
 
 TL;DR:変更を行うときに既存のクライアントを破るのを防ぐためにAPIをバージョン化する必要があります。 TL;DR:変更を行うときに既存のクライアントを破るのを防ぐためにAPIをバージョン化する必要があります。 トラブル 
 
 
 
 
 
 
 
 
 クライアント アプリケーション クラッシュ 統合の失敗 最低限のサプライズ原則の違反 ダウンタイム 壊れた信頼 ロールバックの必要性 開発時間の無駄 ユーザー体験の劣化 ソリューション↓ 
 
 
 
 
 
 
 
 
 
 
 
 
 Semantic Version を追加 Backward Compatibilityの実装 削減警告の作成 ロードマップ作成 コンテンツ交渉の活用 Parallel バージョン 早めに変更通知 特徴を徐々に解消 ドキュメントが明確に変更を破る Check deprecated parameters with logging(ログリングで削除されたパラメータをチェック) 新しいバージョンを徹底的にテスト 日没後の機能削除 コンテキスト 適切なバージョニングなしで API を変更すると、既存のすべてのクライアントに影響を与える大規模な変更を生成します。 あなたは、消費者がすぐにコードを更新するか、システムの故障に直面するように強制します。 あなたは、APIプロバイダーと消費者の間の暗示的な契約を破ります。 現代のソフトウェアは、APIの安定性に大きく依存しており、予告なく破壊的な変更を導入することは、依存するシステム間でカスカディングの故障を引き起こす可能性があります。 今日、これまで以上に重要なのは . 多くのAIは既存のAPI文書を使用してソリューションを構築します。 後ろ向きの互換性を維持せずにAPIを更新すると、それに依存するすべてのアプリケーションを破壊するリスクがあります。 これは、ユーザーにとって不安定性、失望、そして高価な修正を生み出す。 顧客はしばしば寛容 新しい機能で、以前の安定した行動を破ったことはありません。 欠点 適切なバージョニングはスムーズな移行を保証し、システムの信頼性を維持します。 サンプルコード 間違えました↓ // user-api-v1.json - Original API response
{
  "id": 317,
  "name": "Mr Nimbus",
  "email": "nimbus@atlantis.com",
  "nationalities": "Brazilian,Canadian,Oceanic"
}

// Later changed to this without versioning:
{
  "userId": 317,
  "fullName": "Mr Nimbus", 
  "emailAddress": "nimbus@atlantis.com",
  "createdAt": "2018-12-09T18:30:00Z",
  "nationalities": ["Brazilian", "Canadian", "Oceanic"]
}

fetch('/api/users/317')
  .then(response => response.json())
  .then(user => {
    // This breaks when API changes field names and data types
    document.getElementById('name').textContent = user.name;
    document.getElementById('email').textContent = user.email;
    // This breaks when nationalities changes from string to array
    document.getElementById('nationalities').textContent 
      = user.nationalities;
  });
 正しい // user-api-v1.json - Version 1 (maintained)
{
  "id": 317,
  "name": "Mr Nimbus",
  "email": "nimbus@atlantis.com",
  "nationalities": "Brazilian,Canadian,Oceanic"
}

// user-api-v2.json - Version 2 
// (new structure, backward compatible)
{
  "id": 317,
  "userId": 317,
  "name": "Mr Nimbus",
  "fullName": "Mr Nimbus",
  "email": "nimbus@atlantis.com",
  "emailAddress": "nimbus@atlantis.com",
  "createdAt": "2018-12-09T18:30:00Z",
  "nationalities": "Brazilian,Canadian,Oceanic"
  "nationalitiesList": ["Brazilian", "Canadian", "Oceanic"]
}

// user-api-v3.json - Version 3 
// (new structure, backward not compatible)
{
  "userId": 317,
  "fullName": "Mr Nimbus",
  "emailAddress": "nimbus@atlantis.com",
  "createdAt": "2018-12-09T18:30:00Z",
  "nationalitiesList": ["Brazilian", "Canadian", "Oceanic"]
}

// client-code-versioned.js
const API_VERSION = 'v1';

fetch(`/api/${API_VERSION}/users/317`)
  .then(response => response.json())
  .then(user => {
    document.getElementById('name').textContent = user.name;
    document.getElementById('email').textContent = user.email;
    // V1 handles comma-separated string
    document.getElementById('nationalities').textContent
      = user.nationalities;
  });

// Or with content negotiation
fetch('/api/users/317', {
  headers: {
    'Accept': 'application/vnd.api+json;version=1'
  }
})
  .then(response => response.json())
  .then(user => {
    document.getElementById('name').textContent = user.name;
    document.getElementById('email').textContent = user.email;
    document.getElementById('nationalities').textContent 
      = user.nationalities;
  });
 検出 
 
 (x)半自動 この臭いは、フィールド名を変更したり、フィールドを削除したり、データ構造を変更したりするAPIを見つけた場合に検出できます。 API 展開後に停止するクライアントアプリケーションを探します。 行方不明のバージョンヘッダーやURLのバージョンアップスケジュールを確認してください。 リリース後のクライアントエラーの突然のピークのエラーログをモニタリングします。 タグ ️ 
 
 APIs レベル 
 
 (x) 中間 なんでバッテリーが大事なの️ 安定を保つ必要がある。 あなたのAPI契約と顧客の期待の間で マップ あなたがこれを破るとき バージョニングなしでAPIを変更すると、クライアントが一貫したインターフェイスに依存できるという基本原則に違反します。 バージョン 顧客が受け取ることを期待するものと、APIが提供するものとの間の不一致を作成します。 これは、APIの約束とAPIの配信の1対1の一致を破り、システムの故障と信頼の喪失につながります。 APIs はリアル ワールド サービスをモデル化します. When you break the mapping between your API and the business logic it represents, clients can't reliably interact with your system. API が表示されるビジネス ロジックとの間のマッピングを破ると、クライアントは信頼できるようにシステムと相互作用することはできません。 この不一致は、欠陥、ダウンタイム、信頼の欠如、悪質なユーザーエクスペリエンスにつながります。 世代 AI ジェネレーターは、既存の API を「改善」または「更新」するよう求めるときに、しばしばこの匂いを作成します。 彼らは、後ろ向きな互換性を考慮することなく、APIを「改善」することに焦点を当てています。 AI ツールは、既存のフィールド名を維持し、変更時にバージョニングを追加するように明示的に指示する必要があります。 彼らはしばしば安定性よりもクリーンなデザインを好む。 別に言った。 明示的に 検出 ↓↓ AI generators can fix this smell when you provide clear instructions about API versioning strategies. 彼らにセマンティックなバージョニングを実装し、後ろ向きな互換性を維持し、削減された機能のための移行パスを作成するように依頼する必要があります。 ぜひお試しください!↓↓ 注意:AIアシスタントは多くの間違いを犯す 
 
 Suggested Prompt: Create API versioning to prevent breaking changes. 変更を妨げるためにAPIのバージョニングを作成する Suggested Prompt: Create API versioning to prevent breaking changes. 変更を妨げるためにAPIのバージョニングを作成する 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 Without Proper Instructions 
 With Specific Instructions 
 
 
 
 ChatGPT 
 ChatGPT 
 
 
 
 Claude 
 Claude 
 
 
 
 Perplexity 
 Perplexity 
 
 
 
 Copilot 
 Copilot 
 
 
 
 Gemini 
 Gemini 
 
 
 
 DeepSeek 
 DeepSeek 
 
 
 
 Meta AI 
 Meta AI 
 
 
 
 Grok 
 Grok 
 
 
 
 Qwen 
 Qwen チャット チャット クラウド クラウド Perplexity 戸惑い パイロット パイロット 双子 双子 ディープ検索 ディープ検索 ターゲット AI ターゲット AI グロック グロック QWEN QWEN 結論 ↓ API を常にバージョン化して、クライアント アプリケーションに影響を与える変更を妨げる必要があります。 最初のバージョンからも。 適切なバージョニングを通じて安定した契約を維持すると、API消費者との信頼を構築し、システムのスムーズな進化を可能にします。 壊滅的な変化は避けられないが、顧客を壊すべきではない。 常にAPIをバージョン化し、慎重に削除し、不要な中断を避けるために積極的にコミュニケーションをとります。 https://hackernoon.com/misusing-http-status-codes-wrecks-your-api-monitoring-and-client-logic https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-iv-7sc3w8n https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xii https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxii https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxiv https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxv ディスカレーター Code Smells Are Mine(コードの匂いは私のもの) . 意見 クレジット↓ 写真 by は ジャンカルロ・リボレド Unsplashについて 
 
 APIは永遠に存在するので、慎重に設計してください。 APIは永遠に存在するので、慎重に設計してください。 マーティン・ファウラー https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true この記事は CodeSmell シリーズの一部です。 https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-i-xqz3evd?embedable=true

Winner of Noonies 2020 for the award Hacker Noon Contributor of the Year - REFACTORING.

2020 - Hacker Noon Contributor of the Year in REFACTORING

2022 - HackerNoon Contributor of the Year - Clean Code

2022 - HackerNoon Contributor of the Year - Debugging

2022 - HackerNoon Contributor of the Year - Github

2022 - HackerNoon Contributor of the Year - Machine Learning

2022 - HackerNoon Contributor of the Year - Quality Assurance

2022 - HackerNoon Contributor of the Year - Refactoring

2022 - HackerNoon Contributor of the Year - Software Architecture

2022 - the Greatest Storyteller

Buy My Book

Share your ideas with me!

Read My Stories

Buy Me a Coffee

Software Engineer and Book Author

このオーディオは、ストーリーの元の言語で制作されています。

長すぎる; 読むには

Code Smell 303 - 変更を行うときに既存のクライアントを破壊するのを防ぐ方法

Code Smell 303 - 変更を行うときに既存のクライアントを破壊するのを防ぐ方法

About Author

コメント

ラベル

この記事は

Related Stories

HackerNoon ライティングコンテストで優勝したいですか? #crypto-api コンテスト優勝者のおすすめはこちら

デジタルノマドの皆さん、タイの新しい DTV ビザについて知っておくべきこと

フロキのヴァルハラがインドのスリランカツアーのアソシエイトスポンサーに加わる

18 種類の開発者ツールで生産性を向上しましょう 🚀🔥

HackerNoon ライティングコンテストで優勝したいですか? #crypto-api コンテスト優勝者のおすすめはこちら

デジタルノマドの皆さん、タイの新しい DTV ビザについて知っておくべきこと

フロキのヴァルハラがインドのスリランカツアーのアソシエイトスポンサーに加わる

18 種類の開発者ツールで生産性を向上しましょう 🚀🔥

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps