API の検索、評価、統合を容易にするツール「API Hub for Explore」を使ってみよう！

Swagger を搭載した SmartBear API Hub は、複数のツールの機能を 1 つのシームレスなワークフローに統合し、API のデザイン、テスト、ドキュメント化を容易にします。

この記事では、SmartBear API Hub のコンポーネントの 1 つであり、API の検索、評価、統合を容易にする API Hub for Explore の GUI の概要と基本操作を説明します。また、チュートリアルでは、REST API の PUT、GET、DELETE を使用してデータを追加、取得、削除する方法と、Kafka サービスをサブスクライブして公開する方法を紹介します。

API Hub for Explore により、API の理解、検証、統合を迅速に行えるようになる同時に、エンゲージメントを高め、オンボーディングをスピードアップできます。

API Hub for Explore メイン画面の概要
1. コンポーネントと組織の切り替え
API Hub for Explore を使ってみる
REST API のチュートリアル
1. 準備
2. Petstore API サンプル
Kafka サービスのチュートリアル
1. 準備
2. Kafka API イベントストリームの例
  1. イベントストリームをサブスクライブする
  2. Kafka で公開する
関連情報

API Hub for Explore メイン画面の概要

API Hub for Explore を開くと、左側のツールバーに以下のアイコンが表示されます。

Explore: API Hub for Explore のメイン画面です。メインの作業領域であり、現在の操作が個別のタブに表示されています。
Spaces: API 操作をブックマークフォルダーのようにグループ化できます。詳細は、「スペースに操作を保存する」を参照してください。
History: 過去 1,000 件分の操作ログが日付の降順で表示されます。
API Hub for Design: API Hub for Design から API を選択して API Hub for Explore で作業できます。

画面上部には、標準的な Web ブラウザーと同様にタブが並んでいます。API Hub for Explore を終了すると、すべてのタブが閉じられます。[History] ログから以前のタブの内容を取得して、操作を再度実行できます。

[Explore] 画面には、以下のエリアがあります。

操作の詳細: 接続の設定を指定します。以下の項目があります。
- Protocol: Kafka または REST。
- Operation: REST の場合、GET、PUT、POST、DELETE、OPTIONS、または PATCH 操作を選択できます。Kafka の場合、publish または subscribe を選択できます。
- Authorization: 必要に応じて、認証情報を指定します。
- Connection: 接続タイムアウトなど、API インタラクションの接続設定を指定します。
- Headers & Parameters: 操作で使用するパラメーター値を指定します。
- Body: 操作の本文で送信するテキストを入力します。
サーバーとパス: [Server] フィールドに URL を入力します。API Hub for Explore は、http:// が省略されている場合は自動的に追加し、URL のパス部分を [Path] フィールドに移動します。
設定の表示領域: デフォルトでは、[Headers & Parameters] の値が設定の表示領域に表示されます。他の設定項目をクリックすると、その項目が表示されます。
レスポンス: [Send] をクリックすると、ここに API レスポンスが表示されます。

コンポーネントと組織の切り替え

API Hub のコンポーネントを切り替えるには、左上のメニューをクリックして、コンポーネントを選択します。
組織が 1 つ以上ある場合は、右上の組織名のドロップダウンから組織を切り替えることができます。
現在のサブスクリプションの機能を確認するには、サブスクリプション名のドロップダウンをクリックします。

API Hub for Explore を使ってみる

REST GET 操作を使用して Petstore API の OpenAPI 定義を返す例を用いて、API Hub for Explore のワークフローを説明します。以下の操作を行います。

[Protocol] フィールドを REST に設定します。
[Operation] フィールドを GET に設定します。
次の URL をコピーして、[Server] フィールドにペーストします。
```
https://petstore3.swagger.io/api/v3/openapi.json
```
API Hub for Explore は URL を解析して、自動的に [Path] フィールドを更新します。
[Send] ボタンをクリックして API を呼び出します。
[Response] セクションに戻り値が表示されます。デフォルトでは、レスポンスの本文が読みやすい色付きのテキストで表示されます。

REST API のチュートリアル

API Hub for Explore で REST サンプルを使って、以下の操作を行ってみましょう。

PUT 操作を使用したデータの作成
GET 操作を使用した新しいデータの取得
DELETE 操作を使用したデータの削除

準備

以下が必要になります。

API Hub for Explore へのアクセス
REST API の基礎知識

Petstore API サンプル

最初に、パブリックの Petstore API で許可されている操作を見てみましょう。swagger.io で確認できます。ペットストアでは、以下の操作を行うことができます。

これらの API 操作を API Hub for Explore に入力すると、API Hub for Explore はそれぞれの操作に対して値を返します。

POST 操作の使用

新しい犬をペットストアに追加してみましょう。名前は Rex で ID は 20 です。以下の操作を行います。

[Operation] メニューから [POST] を選択します。
次の URL をコピーして、[Server] フィールドにペーストします。
```
https://petstore3.swagger.io/api/v3/pet
```

[Body] をクリックして、次のリクエストを [Body] フィールドにペーストします。

{
  "id": 20,
  "name": "Rex",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

[Send] をクリックします。データが正常に追加されたことを確認するレスポンスが表示されます。

GET 操作の使用

Rex がペットストアに追加されたことを確認します。以下の操作を行います。

[Operation] メニューから [GET] を選択します。
[Path] フィールドに次の文字列 (パラメーター) を追加します: /{petid}。
[Headers & Parameters] テーブルで [petid] 行をクリックし、[Value] 列に Rex の ID 値 20 を入力します。これで、petid パラメーターが設定され、ID 値 20 のレコードを検索するように指定されます。
[Send] をクリックします。追加したデータがペットストアに存在することを確認するレスポンスが表示されます。

重要: これはパブリックテスト API です。パブリックテスト API に追加されたデータは定期的に削除され、長期間は保存されません。

DELETE 操作の使用

Rex をペットストアから削除してみましょう。以下の操作を行います。

[Operation] メニューから [DELETE] を選択します。ほかのすべての設定 (パスやパラメーター) は、すでに正しく設定されています。
[Send] をクリックします。ペットストアから Rex が削除されたことを確認するレスポンスが表示されます。

Kafka サービスのチュートリアル

API Hub for Explore で Kafka サービスをサブスクライブして公開する基本操作を行ってみましょう。

準備

以下が必要になります。

API Hub for Explore へのアクセス
Kafka サービスの基本知識
Kafka インストールへのアクセス

Kafka API イベントストリームの例

このチュートリアルでは、Kafka サイトを使用します。Kafka サイトはご自身で用意し、以下の設定はサイトに応じて調整してください。

イベントストリームをサブスクライブする

Kafka のイベントフィードをサブスクライブしてみましょう。以下の操作を行います。

[Protocol] メニューから [Kafka] を選択します。
[Operation] メニューから [Subscribe] を選択します。
[Server] フィールドにサーバーアドレスを入力します。
[Channel] フィールドにチャネルを入力します。
[Authorization Settings] をクリックして、ログイン認証に必要なフィールドを入力します。
[Connection Settings & Parameters] をクリックして、サブスクリプションの有効期間の指定に必要なフィールドを入力します。
[Subscribe] をクリックしてサブスクリプションを開始します。イベントが発生すると、[Received Messages] セクションにレコードが新しいものから降順に表示されます。
各イベントメッセージをクリックするとその詳細を表示できます。