統合機能の開始以来、SwaggerHubチームはAPIプロジェクトに最高のツールを提供するために継続的に努力してきました。SwaggerHubエディタ自体は、Swagger定義の作成と視覚化の両方において強力なツールですが、APIが実際にどのように動作するかを設計者が迅速に反復できる場合、設計プロセスは大幅に改善されます。クライアントの視点からAPIの外観と使用感を扱うことは、素晴らしいAPIを構築するための第一歩であり、私たちの最新の統合はまさにそれ、Smartbear VirtServer統合を可能にします！VirtServerはSmartBear Ready! API仮想化製品の一部です。SwaggerHubのVirtServer統合は、基本的な仮想機能をAPIライフサイクルに直接統合します。有効にすると、VirtServer統合はSwaggerHubで定義されたAPIの半静的モックを自動的に作成および維持します。このモックはAPIを保存するたびに更新されるため、モックサービスを作成するために外部ツールを見つけて使用する必要がなくなります。VirtServerによって生成されたプレビューを使用して、チームと効率的に設計を反復することができ、すべて数回のクリックで行えます。
VirtServerを有効にする
SwaggerHubのGitHub同期やWebhook統合と同様に、SmartBear VirtServer統合は、右上隅の「統合の管理」オプションからAPIに追加できます。
SmartBear VirtServer統合の真の有用性は、統合の追加と構成がいかに簡単であるかを見ればわかります。VirtServerを設計ニーズに合わせて最適化するために使用できるフィールドは次のとおりです。
- 名前: 特定のVirtServer統合の名称です。
- APIトークン: 任意のAPIトークンが指定され、統合が有効にされると、モックサーバーへの各リクエストはAuthorizationヘッダーにこのトークンを含める必要があります。これはSwaggerHubのプライベートAPIでのみ利用可能です。
- APIトークン: 任意のAPIトークンが指定され、統合が有効にされると、モックサーバーへの各リクエストはAuthorizationヘッダーにこのトークンを含める必要があります。これはSwaggerHubのプライベートAPIでのみ利用可能です。
- デフォルトの応答コンテンツタイプ: API仕様で指定されていない場合、モックが返すデフォルトの応答コンテンツタイプ。
- ホスト設定の更新: 統合がSwagger仕様を変更して、basePath、host、またはschemesプロパティを自動的にモックを指すように更新することを許可します。これにより、エディタとインタラクティブUIが仮想サーバーを直接呼び出すことができ、自動生成されたクライアントSDKがサーバーを指すように構成することもできます。
統合が有効にされると、モックはすぐに使用できます！
複数の定義済み応答の生成
この生成されたモックには、各producers/response-messageの組み合わせに対して静的な応答が作成されます。操作に複数の応答がある場合、モックはそれらを順番に循環します。たとえば、操作に200、404、500の応答がある場合、それらはその操作に対して順番に返されます。モックサーバーは、API設計を検討する際に強力なツールとなります。コードを1行も書かずに、APIコンシューマーがVirtServerに対してクライアントを開発することを許可でき、互換性のある現実的なペイロードで応答することが保証されます。さらに重要なのは、モデル定義内で「example」構造を使用することで、Swagger定義でペイロードを直接調整できることです。VirtServer統合の設定方法については、ドキュメントをご覧ください。この統合はSmartBear Softwareの皆様のおかげです！今後、この統合やその他の統合における将来の機能強化にご期待ください。新しい統合に関するご提案や、製品をSwaggerHubと統合したい場合は、こちらから機能リクエストをお寄せください。