メインコンテンツまでスキップ

Developer Portal API Product Publication

概要​

このチュートリアルでは、Developer PortalでAPI製品を作成し、公開するプロセスを説明します。APIMにおける製品は、複数のAPIをグループ化し、タイトル、説明、ロゴ、ドキュメントリンクなどの製品レベルのメタデータを定義することを可能にします。公開された製品は、開発者が発見し、使用できるようになります。

前提条件​

  • APIMコンソールにデプロイされたAPIが少なくとも1つ利用可能であること
  • 管理者 > 製品管理への管理者アクセス

ステップバイステップチュートリアル​

ステップ1. 新しい製品を作成する​

管理者 > 製品管理に移動し、プラスボタンをクリックします。

ポップアップで：

  • 製品名を入力: sk01
  • 確認をクリックして進みます。

ステップ2. 基本的な製品情報を入力する​

製品を作成した後、詳細ページにリダイレクトされます。

Field Example
名前sk01 (自動入力)
説明認証およびユーザー管理API
製品イントロリンクhttps://developers.skapim.co.kr/product/sk01/overview
製品を有効にするチェック(Developer Portalに表示)
APIドキュメントリンクを有効にするチェック(製品詳細ページでAPIドキュメントアクセスを有効化)
製品アイコンicon-sk01.png (1:1比率、表示サイズ40x40px)

基本情報を保存するには、保存をクリックします。

ステップ3. 製品にAPIを追加する​

製品詳細ビューのAPIタブに切り替えます。

この製品にAPIを割り当てるために、追加ボタンをクリックします。

利用可能なAPIフィールド：

フィールド例
プロジェクトmj-test-kong
ゲートウェイmj-test-kong-gateway
APItestFromBff0052
説明helloworld2222
タグ

追加を確定するには、チェックアイコンをクリックします。

次のことができます：

  • 複数のAPIを追加する
  • APIを削除する (Xアイコン)
  • 各APIを表示または編集する（ギアまたは表示アイコン）

ステップ4. 開発者ポータルで製品を有効化する​

製品リストに戻ると、新しいエントリが表示されます。

列説明
チェックボックス開発者ポータルで製品を公開または非表示にするためのトグル
順序製品リストでの表示順序を定義する（0 = 上）

表示位置を編集した後、注文を保存をクリックします。

ベストプラクティス​

  • 製品名は意味があり、ユニークに保つ
  • 一貫した表示のために1:1比率のアイコン（40x40px）を使用する
  • 関連するAPIを単一の製品にグループ化して簡単に発見できるようにする
  • 製品イントロリンクを使用してユーザーをドキュメントやビジネス概要に接続する
  • 内部組織やフロントエンドフィルターのためにタグを使用する