API のタグを作成、追加、表示、削除する方法について説明します。
背景情報
DataService Studio では、API の生成、登録、デプロイ、およびワークフローの管理時にタグを追加して、効率的に分類および検索できます。タグはワークスペースに固有のものであり、ワークスペース間で共有されません。説明
- 各 API には、最大 5 つのオプションのタグを追加できます。
- 各タグの長さは最大 20 文字で、漢字、英字、数字、アンダースコア (_) を使用できます。
API タグの作成
- DataService Studio のページに移動します。
- [サービス開発] ページで、
アイコンにマウスオーバーし、 をクリックします。 - [API の生成] ダイアログボックスの [タグ] セクションにタグ名を入力します。
タグがワークスペースに存在しない場合、ドロップダウンリストに [<タグ名> を追加] が表示されます。[<タグ名> を追加] をクリックして、新しいタグを API に追加します。各 API には最大 5 つのタグを追加できます。
- 他のパラメーターを設定した後、[確認] をクリックします。新しいタグがワークスペースのタグリストに追加されます。他のパラメーターの詳細については、「データソースから API を生成する (API Gateway)」をご参照ください。
API タグの追加
- [サービス開発] ページで、 アイコンにマウスオーバーし、 をクリックします。
- [API の生成] ダイアログボックスで、[タグ] セクションの空白領域またはドロップダウン矢印をクリックして、現在のワークスペースに存在するタグを表示します。
- 追加したいタグをクリックし、他のパラメーターを設定してから [確認] をクリックします。他のパラメーターの詳細については、「データソースから API を生成する (API Gateway)」をご参照ください。
API タグの表示
- [サービス開発] ページで、API リストから目的の API の名前をダブルクリックします。
- 右側のパネルで、[プロパティ] をクリックします。
- [タグ] セクションで、現在の API のタグを表示します。
説明 このセクションでは、現在の API のタグを作成、追加、または削除することもできます。
公開済みの API については、次の方法でもタグを表示できます。
- ページの右上隅にある [サービス管理] をクリックします。
- ページで、目的の API の名前をクリックして [API 詳細] ページに移動します。
- セクションで、API のタグを表示します。
API タグの削除
- [サービス開発] ページで、API リストから目的の API の名前をダブルクリックします。
- 右側のパネルで、[プロパティ] をクリックします。
- [タグ] セクションで、現在の API のタグを表示します。
- 削除したいタグの横にある
アイコンをクリックします。 - API 編集ページで、ツールバーの
アイコンをクリックします。 - ページの右上隅にある [公開] をクリックします。この操作により、公開済みの API からタグが削除されます。
タグによる API の検索
- [サービス開発] ページで、右上隅にある [サービス管理] をクリックします。
- ページでは、[タグ] 列に各 API のタグが表示されます。
API に複数のタグがある場合は、[...] をクリックするとすべてのタグが表示されます。
- [公開済み API] ページで、[詳細検索] をクリックします。
- [タグ] セクションにタグ名を入力して、そのタグを持つすべての API を検索します。
説明 複数のタグで API を検索できます。