APIに特化したチームは、開発ワークフローで新しい機能や更新された機能を配信する速度を常に向上させようと努力しています。API設計に関して、チームが効率を向上させ、APIプログラムのスケーラビリティを向上させるために最も重要なステップの1つは、共通の設計標準を強制することです。
チームが共通の標準を設定し、強制するのに役立つ様々なアプローチが使用されており、リンター、スタイル検証エンジン(多くは社内で構築されています)、さらには手動レビュープロセスなどが含まれます。場合によっては、このレビュープロセスには、API設計の検証やコードのレビューに専念するチーム全体が関与することもあります。
これらのアプローチは少数のAPIを扱う場合には機能しますが、大規模な場合にはどれもうまく機能しません。実際、最近、API開発者のグループを対象に、今後1年間で解決したいAPIテクノロジーの課題について調査したところ、標準化が1位の回答でした。
本日、SwaggerHubに、チームが組織レベルでAPI標準を設定および強制するのに役立つ新機能、API標準化を発表できることを嬉しく思います。
API標準化はどのように機能しますか?
API標準化は、SwaggerHubのOpenAPI定義が企業のAPIスタイルガイドに準拠していることを保証するのに役立ちます。組織の所有者は、さまざまなルールから選択して、操作、パラメータ、モデル定義の準拠をチェックできます。これらのルールは、組織内で開発されているすべてのAPIに適用できます。
APIの新しいバージョンが保存されるたびに、SwaggerHubはAPIが標準に準拠しているかどうかを自動的に検証します。これにより、プロジェクトやチームに関係なく、実際の実装が開発されて稼働する前に、API設計プロセスの初期段階で矛盾を検出して修正することができます。
ワークフローにAPI標準化を追加する
SwaggerHubは、既存のAPI開発ワークフローに簡単に適合するように構築されています。現在のAPI設計プロセスで使用している標準のセットがある場合は、SwaggerHubでそれらのロールがサポートされているかどうかをここで確認できます。API標準化は、強力な再利用可能なドメイン構造と組み合わせて使用することもでき、再利用可能なアセットのライブラリを使用して数分で新しい設計を作成できます。

あるいは、チームが「コードファーストアプローチ」でビルドまたはデプロイプロセスを通じて定義を生成している場合、その定義をSwaggerhubにプッシュして、組織の要件を満たすように検証することができます。これは、以前は独自のパイプラインまたはプロセスが必要だったかもしれません。
この機能の導入に興奮していますが、これはチームや組織にとってより高度な機能を提供する最初のステップにすぎません。来年初めには、API標準化の分野でさらに多くの機能が期待できます。また、あらゆる規模のチーム向けのAPIの設計および開発プロセスを高速化するように設計された機能も増えるでしょう!
API標準化を実際に見てみる
API標準化は、SwaggerHubのEnterpriseプランで利用可能です。
12月13日(木)に、SwaggerHubの新機能であるAPI標準化のライブデモンストレーションを含む無料のトレーニングを開催します。ウェビナー「SwaggerによるAPI標準の大規模な構築と強制」では、チームがAPIを大規模に設計する際に直面する課題について考察し、組織がAPI設計を標準化するために講じることができる手順を紹介します。
今すぐ登録