SwaggerHub - ドメイン

より素早く API を構築

» SwaggerHub: (主な機能に戻る)

API を設計して開発するには、説明を繰り返して書き直すことが必要です。これは、時間がかかり、イライラすることもあります。ドメインに参加しましょう。

ドメインは再利用可能なコンポーネントの集合です。ドメイン内に格納できるコンポーネントは次のとおりです。

  • Definitions - API の入力と出力を記述するモデルです。
  • Path Items - パス全体で再利用できる一連の定義済み操作
  • Parameters - API への入力
  • Responses - API 呼び出しからの出力

ユーザーは Domains を作成してバージョンを作成し、その中に格納できる再利用可能なコンポーネントを定義できます。コンポーネントは、API 上のユーザーまたは共同作業者によって、他の API またはドメインから参照することができます。 Domain UI は、すべての API 関係者がドメインのコンポーネントをより視覚的に視覚化できるようにするとともに、エラーの迅速な可読性と検出を可能にします。

ドメインを作成する

適切な名前とバージョンのドメインが設定されると、ユーザーはドメイン内に必要なコンポーネントを追加できます。コンポーネントを配置すると、ドメインをパブリッシュすることができます。

ここでは、開始に役立つサンプル ドメインを紹介します。

ユーザー自身のドメインを参照するのは簡単です! 参照を開始して SwaggerHub は、新しい自動提案機能で適切なドメインとコンポーネントを選択する手助けをします。参照するドメインのオブジェクトの名前を入力すると、自動提案が表示されます。

以下の構文を使用して、パブリック ドメインまたは共有プライベート ドメインを直接参照することもできます。

$ref:
'https://api.swaggerhub.com/domains/{ownerId}/{domainName}/{domainVersion}#/{componentType}/{componentName}'

ドメインの管理

ドメインは API と同じ方法で管理されます。作成されたドメインを編集したり、別のバージョンに進んだり、GitHub にプッシュしたり、削除することができます。ドメインはパブリックまたはプライベートのいずれかです。パブリック ドメインは、他の SwaggerHub ユーザーによって検索、表示、参照、および分岐することができますが、プライベート ドメインは作成者自身と作成者が追加した共同編集者だけが表示して作業することができます。

ドメインは、複数の API のコントロール センターとしても機能することができます。ドメイン内の 1 つの変更は、ドメインを参照するすべての API に素早く送信できるため、API の開発とコラボレーションを高速化できます。

 

ページ トップに戻る