API の検出

時間: 25 分 スキル・レベル: 初級

目標

このチュートリアルでは、IBM® API Connect for IBM Cloud® V5 開発者ポータルでポータル・ユーザーが API を利用する方法を学習します。ポータル・ユーザーが製品や API を探索したり、API を表示してテストしたり、API をサブスクライブしたりする方法を学習します。

前提条件

このチュートリアルに前提条件はありません。ポータル管理者も、このチュートリアルで開発者ポータル内をナビゲートすることによって、ポータル・ユーザーが開発者ポータル内をナビゲートする方法を実際に体験できます。ただし、開発者ポータルごとにスキンが違うことに留意してください。

既存の開発者ポータルがない場合は、このチュートリアルの作業を進める前に、IBM Cloud で開発者ポータルをセットアップして構成できます。

製品 & API の探索

このセクションでは、開発者ポータルでポータル・ユーザーが製品および API を探索する方法を取り上げます。

ブラウザーで、 API Connect 開発者ポータルにナビゲートします。
API Connect 開発者ポータルで、「API 製品」タブを選択します。
使用可能な API 製品を 1 つ選択して、その製品で使用できる API とプランを表示します。
API を選択し、使用可能な API の詳細を探索します。
API の詳細ページに、使用可能な操作と、それぞれのパラメーターや返される応答が表示されます。ページの最後に、API で使用されている定義が表示されます。
コード・サンプルのパネルで、各種コーディング言語のサンプルを表示して、要求の呼び出し方や応答の内容を確認できます。サンプルの 1 つ (Node など) を選択すると、そのコーディング言語のサンプルが表示されます。

API の表示とテスト

このセクションでは、ポータル・ユーザーが製品で使用できる API を表示してテストする方法を取り上げます。

API Connect 開発者ポータルで API の詳細ページに移動します (前のセクションを参照)。
**「Open API」**を選択して、API の OpenAPI (Swagger) yaml の情報をダウンロードして表示できます。
操作の 1 つまでスクロールダウンして、詳細を表示します。操作リンクをクリックして、ページ上のリンクにジャンプすることもできます。
サンプルの下にある右側のパネルで、**「この操作を試してみる」セクションまでスクロールします。パラメーターを入力して、「操作の呼び出し」**を選択します。
スクロールダウンして、操作の呼び出しの要求と応答を表示します。応答 200 OK が返され、メッセージ本文と共に表示されます。これは、操作の呼び出しが正常に実行されたことを示しています。

API のサブスクライブ

このセクションでは、開発者ポータルでポータル・ユーザーが API をサブスクライブする方法を取り上げます。

アカウントの作成を選択します。
必須フィールドにデータを入力して、ページの下部にある**「新規アカウントの作成 (Create new account)」**を選択します。注: 前のチュートリアルで開発者ポータルの作成に使用したものとは異なる E メール・アドレスを使用してください。
開発者アカウントを作成したら、ログインしてホーム・ページを表示します。 API をサブスクライブするためのアプリケーションが必要です。 **「アプリケーション」**を選択して、登録済みアプリケーションのページに進みます。
新しいアプリケーションを登録する場合は、**「新しいアプリケーションの作成」**を選択します。
アプリケーションのタイトルと説明を入力して、**「サブミット」**を選択します。
アプリケーションが手に入ったので、API 製品プランをサブスクライブできます。 使用可能な API または API 製品を選択して、API 製品プランを表示します。
サブスクライブする API 製品を選択します。
**「サブスクライブ」**を選択して、API 製品プランをサブスクライブします。
製品プランをサブスクライブするアプリを選択し、 **「サブスクライブ」**を選択します。
アプリケーションは製品プランを正常にサブスクライブしました。

まとめ

このチュートリアルでは、ポータル・ユーザーが製品や API を探索したり、API を表示してテストしたり、API をサブスクライブしたりする方法を学習しました。

次のステップ

基本的な分析を行って洞察を深める方法を学習します。

作成 > 管理 > 保護 > ソーシャル化 > 分析