SwaggerHub チームは先日、無料の API デザイントレーニング「API デザインのスケーリング：API デザイン時にユーザビリティを向上させ、開発者の生産性を最大化する方法」を開催しました。この 1 時間のウェビナーでは、API デザインのベストプラクティス、効果的な API デザインが何を意味するのか、API デザインにおける Swagger の役割について議論し、API チームが API デザイン標準を維持する上で直面する最大の課題のいくつかに取り組みました。また、過去 1 年半の間に、複数の内部および外部 API にわたる API デザインプロセスをスケールアップするために、API デザインの課題に対処するソリューションの構築に投資してきた中で学んだ教訓も共有しました。ウェビナーの全編は以下をご覧ください。
SwaggerHub による API デザインのスケーリング
ウェビナーでは、SwaggerHub チームが、チームが API デザインプロセスをスケールアップするのに役立つ SwaggerHub で利用できる高度な API デザイン機能の一部を紹介しました。
- スタイルバリデーター： スタイルバリデーターを使用して、Swagger 仕様が特定の記述標準に一致するかどうかを確認します。たとえば、会社のガイドラインでは、すべてのプロパティに例が指定されている必要がある場合があります。スタイルバリデーターは、このようなチェックを自動化するのに役立ちます。スタイルバリデーター統合を作成する際、実行するチェックを指定します。スタイルバリデーターを実行すると、これらのチェックに従って Swagger 仕様がチェックされ、問題があれば通知されます。詳細はこちら。
- ドメイン： ドメインは、複数の API や他のドメイン間で共有できる再利用可能なコンポーネントです。ドメインには、定義、パス項目、パラメーター、応答などのコンポーネントを含めることができます。ユーザーはドメインを作成およびバージョン管理し、その中に保存できる再利用可能なコンポーネントを定義できます。これらのコンポーネントは、ユーザーまたは API の共同作業者によって、他の API またはドメインから参照できます。詳細はこちら。
SwaggerHub を初めてご利用の方へ
SwaggerHub は、最新の Swagger (OpenAPI) 標準に完全に準拠した強力なエディターで API を迅速に設計および編集できます。SwaggerHub は、チームの設計ワークフローをサポートする機能を提供します。
- クラウドベースのエディター
- Swagger 準拠の自動構文検証
- インテリジェントな構文の自動補完
- 静的応答のための組み込みモック
- 設計プロセス全体にわたるリアルタイムのコミュニケーションと問題追跡
今すぐ無料で始めましょう！