API ライフ サイクル ミキサーのマニュアル: 単一の真実の情報源には何が入るのか?

Oct 24, 2023

投稿者: Ariel DiFelice、2023 年 6 月 9 日

バーテンダーにおいて、ミキサーのマニュアルは信頼できる情報源です。 これらの本には、古典的なカクテルのレシピが数百件掲載されており、その中には 100 年前のものもあれば、最近登場したばかりの飲み物のものもあるかもしれません。 ミキサーのマニュアルは、バーやレストランの提供する料理に刺激的な追加を加えるための、まだテストされていない新しいレシピの優れたインスピレーション源にもなります。 古いものを保存しながら新しいものへの探求を促すというこのバランスをとる行為は、ソフトウェアの世界での API 開発に貴重な教訓を提供することができます。 API の「唯一の信頼できる情報源」は、多くの意味で、ソフトウェア組織独自のミキサーのマニュアルです。 これは、ソフトウェアの機能とパフォーマンスを維持し、顧客を喜ばせ、またリピートし続けるエクスペリエンスを提供するために適切なアプローチが取られている場合に特に当てはまります。

私たちはミクソロジーとこの技術を実践するミクソロジストを比較的新しい用語と考えるかもしれませんが、「ミクソロジスト」という言葉が最初に記録されたのは 1852 年に遡り、その直後に「ミクソロジスト」が使用されるようになりました。

ミクソロジストと API 開発者およびデザイナーの仕事、考え方、情熱はどのくらい似ているのでしょうか? ミクソロジストのこの定義を確認して、自分で類似点を数えてください。

「『ミクソロジスト』という用語は、ミックスドリンクの歴史を研究し、使用される材料と技術を深く理解し、定期的に新しい革新的なミックスドリンクを作成する人を指します…彼らの役職名は、彼らが仕事の重要な部分を裏で行うことを暗示しています新しいクラフトカクテルを作成し、既存のお気に入りに特徴的なひねりを加えて、シーンを再現します。」

世界の最高の API 開発者、デザイナー、アーキテクトは、自分の仕事において上記の多くのことを認識している必要があります。 彼らは自分たちの技術に深い敬意を持っており、常にそれをさらに磨き続けています。 彼らは消費者の好みや味覚を理解しようと努めています。 これらの API を運用環境に「提供」する前に、他の関係者の入力を考慮に入れ、作成したものをテスト、反復、および再度テストします。

ミクソロジストとバーテンダーのように (これらを 2 つの異なる役割として捉える場合)、API ライフサイクルに沿ったすべての専門家は、消費者、顧客、ビジネスのニーズを理解し、それに応じて API を設計および開発する必要があります。 このプロセスの重要な部分は、継続的な検証と市場要件への適応です。

API への変更は、たとえ軽微な変更であっても、下流に重大な影響を与える可能性があります。 そして、同じことが、古くからあるカクテルのレシピに加えられた微調整にも言えます。つまり、あれやこれやを 1 ダッシュ追加または削除するだけで、飲み物の風味が完全に変化する可能性があるだけでなく、その飲み物に対する人々の興味も完全に変化する可能性があります。

計画すべき API への「標準」変更率はありませんが、新しいソフトウェア リリースごとに変更が必要になることが予想されます。 これは、リリース頻度に応じて、数週間ごと、毎月、さらには毎日、変更が行われる (そして、テストと検証が必要になる) ことを意味する可能性があります。 必要に応じて、その場限りの変更が行われる場合もあります。

チームにとって重要なことは、これらの変更によって API の機能やパフォーマンスが中断されないことを確認することです。 これを可能にするために、チームは API コントラクト テストをますます活用して、ある種のセーフティ ネットを提供しています。 これは、API の元の、合意された、したがって必要な機能を詳述する「契約」に照らして変更を検証するテストの形式で行われます。

API への変更の影響を予測できるかどうかは、エンジニアリング チームの成熟度と、部門、タイムゾーン、およびさまざまなレベルの技術的専門知識を超えてコラボレーションできるチームの能力に依存します。 標準化とコラボレーションを促進するツールとガイドラインは、下流への悪影響を見落としたり、無視したりすることによる事故を防ぐことができます。

公開されている API の最新バージョンについて信頼できる唯一の情報源について話している場合でも、実証済みの飲み物レシピに関するミキサーのマニュアルの最新版について話している場合でも、明確で簡潔なドキュメントは重要です。鍵。 しかし、このドキュメントは単に存在するだけでは十分ではありません。

API ドキュメントも簡単にアクセスでき、理解しやすく、使いやすいものである必要があることは、おそらく常識ではない場所で働いたことがあるでしょうが、常識のように思えます。 これらすべてを確実に行うことは、よりスムーズなオンボーディングと前向きな開発者エクスペリエンスにつながり、最終的には期待を満たす、またはそれを超える機能的でパフォーマンスの高い API の幅広い採用につながります。

API ドキュメントは、多くの場合、開発者と API との最初の接点になります。 これはガイドとして機能し、API の機能、エンドポイント、リクエスト/レスポンス モデル、エラー メッセージを開発者に説明します。 また、基礎となるビジネス ロジックと API の固有の特性についての洞察も得られます。

優れた API ドキュメントは、信頼できる唯一の情報源の原則に従います。つまり、包括的、最新、一貫性のあるものである必要があります。 API の実際の動作を常に反映し、開発者の推測を減らし、誤解やエラーの可能性を最小限に抑える必要があります。

ミクソロジストが顧客に満足のいく体験を提供するために詳細かつ正確なカクテル レシピに依存しているのと同じように、API 開発者は有用で付加価値のある API と強力なアプリケーションを作成して提供するために優れたドキュメントに依存しています。

カクテルの材料を細心の注意を払って調整したり、顧客の進化する好みに合わせて新しいカクテルを作成したりするミクソロジストのように、開発者は、市場の需要、ビジネス ニーズ、業界標準の変化に合わせて API を常に調整する必要があります。

これは、市場調査、コラボレーション、基準とガバナンスの順守、および綿密なテストを強力に組み合わせることで実現されます。 しかし、ソフトウェアの開発、テスト、展開のテクノロジーとプロセスは進化し続けるため、テクノロジー業界は自らを教育し、その実践方法を改良し続ける必要があります。

継続的な学習と継続的な改善、そして信頼できる唯一の真実の情報源をガイドとして重視する考え方により、開発チームは自信を持ってすべてのリリースで優れた API エクスペリエンスを提供できます。 最終的な目標は、ミクソロジストの完璧な飲み物のように、信頼性が高く消費しやすく、その時々の固有のニーズを満たす API を作成することです。

Filed Under: API、アプリケーション パフォーマンス管理/監視、ブログ、DevOps 文化、DevOps 実践、DevOps の実践 タグ: API、API、CI/CD、開発者、開発、ドキュメント、SDLC。 ライフサイクル、ソフトウェア、テスト