SmartBearのAPIテクニカルエバンジェリストであるFrank Kilcommins氏がStack Overflow Podcastに出演し、APIライフサイクル全般と、API仕様が開発者のAPI理解にどのように役立つかについて語りました。彼の訪問中に触れた内容について詳しくお読みください。
APIはあらゆる業界のイノベーションを促進し、誰にでも新しい機能へのアクセスを提供します。しかし、だからといってAPIを公開すれば成功するわけではありません。APIが成功するためには可視性が非常に重要ですが、どうすればAPIを可視化できるのでしょうか？
優れたAPI設計に注力する
APIコンシューマーは、APIを迅速に見つけて発見することの恩恵を受けたいと考えており、APIプロバイダーは、コンシューマーが閲覧・操作できるポートフォリオを作成する必要があります。これらのAPIのコンシューマーは、開発者、プロダクトマネージャー、あるいはビジネスアナリストである場合もあります。
このプロセスは単純に聞こえますが、これらのすべてのペルソナにおいて課題であることが証明されています。APIプロバイダーは、API設計に注力し、それが使いやすくアクセスしやすいものであることを確認する必要があります。APIへのアクセスを得るためのオンボーディングと、APIの表面積の探索の経験も非常に重要です。APIコンシューマーがAPIを見つけて操作すると、その価値と制限を即座に理解したいと考えます。APIは使いやすいか？ APIはビジネス要件を満たしているか？ 自分たちで構築する方が簡単か？
APIが迅速かつ容易に評価されれば、APIコンシューマーは、事前に構築されたAPIを統合することでソフトウェア開発ライフサイクルが加速され、時間とリソースが節約され、エラーが制限されることを認識するでしょう。
発見性を向上させる
APIを提供する際にデザインファーストのアプローチを採用することで、開発者は既存の仕様を使用してAPIの品質を保証することができます。
これを行うには、SmartBearのSwaggerHubのような、既存の共通仕様を理解するツールを活用することで、設計プロセス中にAPIをどのように表現すべきかについての標準化されたスタイルガイドを解き放つことができます。そこから、チームは、さまざまな属性やビジネス価値の提供に基づいて、簡単に発見できるようにAPIのカタログを構築し始めることができます。
これにより、組織全体でそれらが使用されることが保証されます。APIが使用されなければ、それは何の価値ももたらしません。そして、何の価値ももたらさなければ、それは役に立たないものです。
APIの重要性を理解する
APIライフサイクル全体を考察する際には、特定のAPIを構築することでどのような問題が解決されるのか、組織内の戦略的ビジョンを理解することが重要です。
その問題をアイデア段階に持ち込み、設計に落とし込み、共同でフィードバックを得て、APIが元のビジネスニーズを解決するかどうかを判断します。繰り返しになりますが、SwaggerHubのようなツールを使用すると、チームはさまざまな仕様（Swagger、OpenAPI、AsyncAPI）を使用して、異なるステークホルダーとAPI設計について共同作業を行うことができます。
共同作業の成果は、他のチームがAPIの開発、テスト、そして最終的なデプロイ作業を開始することを可能にします。
API探索
APIがデプロイされると、APIプロバイダーはユーザーにその価値を見つけてほしいと考え、APIコンシューマーは価値あるAPIを発見したいと考えます。APIの価値を理解するには、摩擦なく探索に特化したツールが必要です。
SmartBearの新しいツール、SwaggerHub Exploreは、API統合に投資する前に、APIが提供する機能と制限をすべて1か所で視覚化します。この新しい無料ツールは、Kafka指向のイベント駆動型エンドポイントやRestful APIを含むマルチプロトコルAPIをサポートしています。
APIを最も効果的に使用するには、APIの動作を理解する必要があります。SwaggerHub Exploreは、APIツールキットに即座に価値を提供する使いやすいインターフェースです。
結論
APIの発見と探索は時間がかかるプロセスですが、その努力は十分に報われます。組織内でAPIエコノミーを構築する際には、APIライフサイクル全体でAPIを見つけ、探索し、管理できる必要があります。これにより、APIが成功し、方程式の両側のユーザー（新しいサービスへのアクセスを望む開発者と、組織や業界全体からのデータフィードを必要とする運用担当者）に価値を提供できるようになります。
Frank氏のさらなる発言は、エピソードを聴いてください。
https://stackoverflow.blog/2023/03/15/visible-apis-get-reused-not-reinvented/
今すぐSwaggerHub Exploreをお試しください: ソフトウェアテスト、監視、開発者ツール - 無料で試す | SmartBear