2018年のAPI戦略を計画する:チームを成功に導くためのツールとリソース

  2017年12月21日

SwaggerHubは、チームがAPIを提供する方法を再考するのに役立つように作成されました。

2017年には、70,000人以上のAPI開発者、デザイナー、テクニカルライター、プロダクトマネージャーがSwaggerHubを使い始めました。その中で、私たちはAPIチームが大規模にAPIを設計、ドキュメント化、提供するために何が必要かについて多くのことを学びました。

また、数百のAPIで複数のチームが連携する際に組織が直面する課題についても多くのことを学びました。

例えば、次のような課題です。

  • 関係者全員がAPIの変更を可視化できるようにするにはどうすればよいですか?
  • ドキュメントを最新の状態に保ちながら、APIを更新およびバージョン管理するにはどうすればよいですか?
  • API設計の一貫性を確保し、APIの構築方法の標準を強制するにはどうすればよいですか?
  • 設計プロセスを進化させ、OpenAPI 3.0のような新しい標準を採用するにはどうすればよいですか?

今年、私たちはAPIチームが直面するこれらの課題やその他の課題に対処するために、いくつかの新しいツールとリソースをリリースしました。また、API分野の業界リーダーやイノベーターに連絡を取り、優れたAPIを提供するために何が必要かについて彼らの視点を得ました。2018年を見据えて、私たちは最高のAPIリソースをいくつか共有し、新年にチームを成功に導くための新しいSwaggerHubの機能の概要を提供したいと思いました。

チームが優れたAPIを提供するためのツール

2017年は、チームがAPI設計とドキュメント作成のワークフローをより良く管理できるように設計された3つの新機能をリリースして始まりました。APIスタイルガイドラインを設定および強制するためのスタイルバリデータ、設計変更をレビューおよびマージするための比較&マージ、チーム内でAPIを整理するためのプロジェクトです。

また、主要なAPIゲートウェイであるApigeeとIBM API Connectの2つとの新しい統合もリリースしました。

2017年の終わりには、最新バージョンのOpenAPI仕様であるOpenAPI 3.0を使用してAPIを設計およびドキュメント化するための初期サポートを追加しました。

API戦略の計画

2017年、私たちは組織がAPIを提供するためにプロダクトマネジメントの原則を採用し、「モダンなAPIエコノミー」のビジネスチャンスを認識するという傾向が継続的に高まっていることを目撃しました。また、計画と設計からドキュメント、テスト、デプロイメントまで、APIのライフサイクル全体に対処する戦略をチームが持つ必要性が高まっていることも目撃しました。

API戦略を計画するための当社の主要なリソースをいくつかご紹介します。

API業界からの洞察

今年1年、私たちはAPIの世界のあらゆる分野の専門家と接触する機会を得て、API設計、コラボレーションから、世界最高のAPIチームが成功したAPI戦略をどのように実装したかまで、幅広いトピックについて彼らの視点を得ました。

以下の最も人気のあるインタビューをご覧ください。

API設計プロセスの計画とスケーリング

OpenAPI(旧Swagger)のような記述形式の人気の高まりにより、API開発への「デザインファースト」アプローチへの注目が高まっています。その結果、組織はAPI設計プロセスを標準化し、APIの設計方法に関する要件を設定するためにより多くの時間と労力を費やしています。

これらのリソースを使用して、設計プロセスを標準化およびスケーリングする方法を学びましょう。

APIドキュメントでAPI開発者エクスペリエンスを向上させる

APIドキュメントは、OpenAPIを扱うチームにとって最大のユースケースの1つであり、Swagger UIのようなツールがこれほど人気になった主な理由の1つです。優れたドキュメントは、ユーザーの採用を増やし、サポートの問い合わせを減らし、APIを扱う人々にとってより良いエクスペリエンスをもたらすのに役立ちます。

今年、初心者と経験豊富なAPIチームの両方がAPIをドキュメント化するのに役立ついくつかのリソースをリリースしました。

OpenAPI 3.0の概要

OpenAPI仕様の開発を促進するグループであるOpenAPI Initiativeは、2017年7月に仕様の最新バージョンを正式にリリースしました。OpenAPI 3.0はSwagger仕様の次の進化形であり、正式に新しい名前になっただけでなく、チームがAPIのライフサイクル全体で仕様を活用するのに役立つ改善と新機能も含まれています。

リリース以来、私たちは3つのトレーニングを開催し、開始するための新しいリソースとドキュメントを多数リリースしました。

2018年にさらに学びたいAPIトピックは何ですか?以下のコメントで質問を共有してください。