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

API Creation / Deployment / Invocation

概要​

このチュートリアルでは、APIMにおけるAPIライフサイクル全体を示します - 新しいAPI定義の作成、Gatewayへのデプロイ、およびHTTPリクエストによる呼び出しの検証までのプロセスです。このプロセスには、リクエストパスの設定、デプロイ先の選択、デプロイ後のAPIレスポンスのテストなど、一般的な実世界の構成が含まれます。

前提条件​

以下の条件が整っていることを確認してください：

  • Gatewayがすでに存在し、アクティブであること（例：gateway-prod-mj）
  • 開発者または管理者権限でAPIMコンソールにアクセスできること
  • プロジェクトがすでに作成されていること（pj-test-01）
  • 少なくとも1つのGateway URLが登録されていること（例：https://api.sksample.co.kr/gateway-test-01）

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

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

API管理に移動します。「APIを作成」をクリックします。

フィールド例
API名user-service-api
ベースパス/user-service
説明ユーザー登録とログインを処理します
可視性プライベート
タグuser, auth, v1

「次へ」をクリックしてバージョン定義に進みます。

ステップ2. APIバージョンを定義する​

フィールド例
バージョン名v1.0
ターゲットURL（バックエンド）https://backend.sksample.co.kr/user
Gatewaygateway-prod-mj
リクエストメソッドGET, POST, PUT, DELETE
ベースパスの除去有効（バックエンド形式に基づいてオプション）

「保存してデプロイ」をクリックします。

ステップ3. APIをGatewayにデプロイする​

APIが保存されたら：

  • API設定画面に移動します
  • 情報を確認して確認します
  • デプロイをクリックします（バージョンv1.0が選択されていることを確認）
  • ステータスが「デプロイ済み」に更新されるのを待ちます。編集後に再デプロイできます。

ステップ4. デプロイされたAPIをテストする​

APIをテストするには、任意のHTTPクライアント（Postman、curl、ブラウザなど）を使用できます。

curlを使用したテストの例：

curl -X GET "[https://api.sksample.co.kr/gateway-test-01/user-service/v1/status](https://api.sksample.co.kr/gateway-test-01/user-service/v1/status)"

期待されるレスポンス：

{
"status": "ok",
"service": "user-service",
"version": "v1.0"
}

一般的な問題とトラブルシューティング​

Issue Cause Solution
404 Not Found不正なルートパスBasePathとRoutePathの設定を再確認してください
SSLエラーゲートウェイに有効な証明書がないHTTPSが有効で、TLS証明書が有効であることを確認してください
タイムアウトバックエンドターゲットURLに到達できないゲートウェイからバックエンドへのDNSとネットワークアクセスを確認してください
403 ForbiddenAPIキーが必要認証ポリシーが有効になっているか確認してください

ベストプラクティス​

  • BasePathとRoutePathはクリーンでバージョン管理されていること（例：/api-name/v1）
  • 適切なTLSとベースURLの設定がされた検証済みのゲートウェイにのみデプロイする
  • 消費者と共有する前にcurlまたはPostmanでテストする
  • 論理的なグループ化のためにタグを使用する（例：public、internal、v2）
  • ロールバックと反復のためにバージョン履歴を維持する