LoginSignup
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

@tomotagwork(Tomohiro Taguchi)

IBM API Connect 関連メモ - (3)カタログ、開発者ポータルの構成

Last updated at Posted at 2020-08-20

はじめに

IBM Cloud上のAPI Connectを試してみた時の作業ログです。
今回はカタログ、および、開発者ポータルのセットアップ辺りをやってみます。

関連記事

IBM API Connect 関連メモ - (1)既存REST APIの取り込み
IBM API Connect 関連メモ - (2)API Connectツールキットを使用したNode.jsアプリ作成(Loopback)
IBM API Connect 関連メモ - (3)カタログ、開発者ポータルの構成
IBM API Connect 関連メモ - (4)各種APIの管理
IBM API Connect 関連メモ - (5)Secure Gateway経由でのz/OS Connectとの連携
IBM API Connect 関連メモ - (6)API Connect-z/OS Connect間TLS接続
IBM API Connect 関連メモ - (7)z/OS Connect 基本認証 + ID伝播
IBM API Connect 関連メモ - (8)z/OS Connect 連携におけるインターフェースの浄化
IBM API Connect 関連メモ - (9)z/OS Connect 連携まとめ

API公開フロー全体像

なんとなーくAPI公開までのフローのイメージが湧いてきたので図にしてみます。多分こんな感じ。
image.png
前回はAPIの定義作成して製品にパッケージしてカタログに公開するあたりまで。
今回は、カタログ、開発者用ポータルあたりの操作をやってみます。

最初、"製品"とか"カタログ"とかいう文言があんまりピンときてなかったのですが、利用者向けに商品を紹介する時の商品カタログのイメージなんですね。こういう製品がこういうプランでご提供できますよというのをカタログに載せておくと、利用者はそれを見て使いたいプランを選んで使うという....。

チュートリアル実施

カタログの構成

チュートリアルとしては、デフォルトで用意されているSandboxというカタログを使うような手順になっていますが、ここでは以下の記述を参考に別のカタログ作成してそちらを使用してみます。

参考: カタログの構成

新規カタログ作成

API Connectのダッシュボードから、追加 - カタログを選択
image.png

名前を指定して追加
image.png

追加されました。
image.png

設定確認

カタログの設定内容を確認します。
追加されたCatalog-Test01をクリック-設定タブを開きます。

概要
image.png

承認
image.png

ゲートウェイ
image.png

ポータル
image.png

ロール
image.png

拡張
image.png

カタログのパーティション化

カタログは複数の論理的な"スペース"という単位に分割して管理することができるようです(シンジケーション機能)。
スペースを作成してみます。
カタログの設定 - 概要 から "スペース"を有効化します。
image.png

有効にするをクリック
image.png

右上の保存をクリック
image.png

左側のメニュー、および、"スペース"のスイッチの下にスペースの管理へのリンクが表示されるのでいずれかをクリック
image.png

New Spaceの右側のプルダウンメニューから編集を選択
image.png

名前を指定して保存
image.png

追加でもう一つスペースを作ってみます。
image.png

Space-Test01, Space-Test02という2つのスペースが作成された状態になりました。

製品をカタログにステージング

以前作成した製品を、新規に作成したカタログ/スペースに登録(ステージング)してみます。

ドラフトの画面からステージングするAPIを選択します。
image.png

右上のステージングアイコンをクリックすると、ステージング先の選択肢として、上で追加した<カタログ名>-<スペース名>が表示されます。
ここでは、を選択します。
image.png

成功メッセージを確認
image.png

カタログ"Catalog-Test01"の画面に戻ります。
左上のプルダウンメニューから、Space-Test01のスペースを選択します。
image.png

製品が追加されていて、ステージング済みになっていることが確認できます。
製品の右側のプルダウンメニューから、公開を選択します。
image.png

そのまま公開
image.png

成功メッセージが出て公開済みとなります。
image.png

開発者ポータルの構成

参考: 開発者ポータルのセットアップと構成

開発者ポータルを作成

DashboardからCatalog-Test01を選択します。

左上のプルダウンメニューからCatalog-Test01(カタログ)を選択しておきます。(スペースを選択した状態だと後続のポータル構成が行えませんでした)
image.png

設定タブからポータル構成画面を開きます。
ポータルの選択のプルダウンメニューからIBM開発者ポータルを選択し、保存します。
ポータルURLをメモっておきます。
image.png

メッセージを確認してOK
image.png

以下のようなメールが届く
image.png

ログインをクリック
image.png

パスワードを設定
image.png

そのたProfileを編集して保存
image.png

開発者ポータルへのアクセス

これまではAPIプロバイダーや管理者が行う操作イメージでしたが、ここの操作は基本的にはAPIコンシューマーが操作する想定のものです。
ここではとりあえず画面の確認だけ。

カタログの設定タブからポータルを選択し、ポータルURLをクリック
image.png

開発者ポータルの画面が開きます。特に制限を設けていないので、Loginしなくても誰でもAPIが見られる状態になっています。
image.png

上段のメニューからAPI 製品を選択すると、利用可能な製品が確認できます。ここではWeather Provider API productが表示されているのでそれを選択してみます。
image.png

API毎のプランなどが確認できます。
image.png

左側のメニューから特定のAPIを選択すると、そのAPIの仕様などが確認できます。
image.png

開発者ポータルのカスタマイズとテーマの選択

参考: 開発者ポータルのカスタマイズとテーマの選択

開発者ポータルに管理者権限でログインします。右上のAdmin Loginをクリックして、ユーザー名、パスワードを指定してログイン。
image.png

バナーと見出しのカスタマイズ

一番上に管理者用のメニューが表示されます。コンテンツからブロックを選択します。
image.png

Welcome Bannerの編集をクリック
image.png

内容に適当なタイトルを指定し、最後に保存。
image.png

image.png

テーマのカスタマイズ

テーマ - 設定 -API Connect Themeを選択
image.png

リストを選択
image.png

Bartikというのを有効化してみます。
image.png

Bartikが上段の有効なテーマにリストされるようになったので、デフォルトに設定をクリック
image.png

開発者ポータルの画面のテーマが変更されました。
image.png

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?