SwaggerHubは、OpenAPI Specificationの最新バージョンであるOpenAPI 3.0（OAS 3.0）をサポートするための継続的な取り組みの一環として、プラットフォームの主要機能の1つであるドメインのサポートを発表できることを嬉しく思います。
OAS 3.0では、開発者が頻繁に使用するオブジェクト、パスアイテム、レスポンスなどをリストに保存し、API定義全体で参照できるようになります。SwaggerHub Domainsはこれをさらに進化させ、再利用可能なアセットのリストを別のファイルに移動し、複数の異なる定義で参照および使用できるようにします。
SwaggerHubの権限と共有機能を使用すると、選択されたユーザーグループが、より大きなチームや設計作業全体で参照される高レベルのアセットを定義できます。これらの再利用可能なドメインは、バージョン管理、公開、および共同でのフィードバックのために共有できます。
ドメインは、より良いAPIを構築するのにどのように役立つでしょうか？
開発プロジェクトの範囲と規模が拡大するにつれて、新しい変更のレビューおよび検証プロセスが、より大きな配信プロセスにおけるボトルネックの引き金となることがよくあります。多くのチームは、新しいサービスが組織のスタイルガイドラインを満たしていることを検証および保証するために、テスト、コードリンター、またはピアレビューに依存していますが、多くの場合、これらは失敗しやすいです。また、それらは開発の大部分が行われた後に発生するため、問題の修正コストはプロセスの早期段階よりもはるかに高くなります。
ドメインを使用すると、チームは新しい機能のコードが1行も書かれる前に、設計段階でスタイルに関する問題を解決できます。検証と変更は、オーバーヘッドが非常に少ない段階で行うことができ、開発の後半段階での信頼性を高めるとともに、問題修正のコストを最小限に抑えることができます。
当社のAPI標準化機能と組み合わせることで、チームは変更が加えられるたびに適用される高レベルのガイドラインを作成でき、レビューおよび検証段階がサービスのスタイルや構造ではなく、機能に焦点を当てることができます。同じ設計から公開されるドキュメントは、ビルド/デプロイプロセスの一部として記述または生成されるドキュメントよりも、共通の例と構造を共有します。
ドメインを探索
ドメインはSwaggerHubのすべてのプランで利用可能です！定義での設定と参照に関する詳細については、開始するためのドキュメントにいくつかのリソースがあります。
ドメインとAPI標準化機能を組み合わせて、設計やプロジェクト全体でガイドラインを適用する方法について詳しく知りたい場合は、API設計に関するAPI調査の現状と、SwaggerHub内の機能のデモについて検討するウェビナーを最近開催しました。