--- title: "実装" url: https://docs.catalyst.zoho.com/ja/cloud-scale/help/api-gateway/implementation/ description: "Catalyst API Gatewayを使用すると、アプリの関数やWebクライアントのエンドポイントにアクセスするためのAPIを作成し、高度なAPI管理を実行できます。" last_updated: 2026-08-17T12:16:04Z service: Cloud Scale type: general --- # 実装 実装セクションは、CatalystウェブコンソールからAPI Gatewayを設定するためのステップバイステップの手順ガイドです。CLIからのAPI Gatewayの操作については、[CLIヘルプドキュメント](https://docs.catalyst.zoho.com/ja/cli/v1/working-with-api-gateway/introduction/)をご確認ください。 ### API Gatewayの有効化 初めてアクセスする前に、プロジェクトのAPI Gatewayを有効にする必要があります。前述の通り、CatalystアプリケーションでAPI Gatewayを有効にすると、[Security Rules](https://docs.catalyst.zoho.com/ja/serverless/help/security-rules/introduction)の設定は自動的に無効になります。Catalystプロジェクトでホストされている関数とWebクライアントは、APIを作成するまで直ちにアクセスできなくなります。そのため、慎重に進める必要があります。 API Gatewayを有効にした直後に、すべての関数とWebクライアントに対してAPIを作成してください。また、その間にエンドユーザーがそれらにアクセスしないようにしてください。API Gatewayの無効化については[このセクション](https://docs.catalyst.zoho.com/ja/cloud-scale/help/api-gateway/implementation/#disable-api-gateway)をご確認ください。 コンソールからCatalystアプリケーションのAPI Gatewayを有効にするには： 1. Catalyst Cloud Scaleコンソールの_Security & Identity_から**API Gateway**に移動し、**Enable Now**をクリックします。 ![catalyst_apig](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig.webp) 2. 確認ウィンドウで**Proceed**をクリックします。 ![apig_enable](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_enable.webp) CatalystプロジェクトでAPI Gatewayが有効になると、コンソールに通知が届きます。 ### APIの作成 始める前に、APIを作成するためにCatalystプロジェクトに少なくとも1つの関数またはWebクライアントをホストしていることを確認してください。 > **注意:** [開発環境](https://docs.catalyst.zoho.com/ja/deployment-and-billing/environments/development-environment)では、プロジェクトで最大1000個のAPIを作成できます。本番環境ではルール作成の上限はありません。 #### 自動作成 自動作成は、プロジェクトで初めてAPI Gatewayを有効にした際にのみ使用してAPIを自動的に作成できます。既にカスタムAPIを作成している場合は、自動作成にアクセスできません。 Security Rulesから定義を移行する際のプロトコルについては[このセクション](https://docs.catalyst.zoho.com/ja/cloud-scale/help/api-gateway/key-concepts/#auto-created-apis-custom-apis-and-the-default-api)を参照してください。 自動作成を使用して関数またはWebクライアントのAPIを作成するには： 1. CatalystコンソールでAPI Gatewayを有効にした後、**Create API**をクリックします。 ![create_page](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_create_page.webp) 2. **Auto-create API**を選択し、**Next**をクリックします。 ![create_api](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_create_api.webp) 3. すべてのBasic I/OおよびAdvanced I/O Functions、およびWebクライアントがデフォルトで選択されています。 ![apig_autocreate](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_autocreate_1.webp) APIを作成しないサービスの選択を解除し、**Create**をクリックします。 ![apig_autocreate](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_autocreate_2.webp) CatalystがAPI作成プロセスを開始します。 ![apig_autocreate](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_autocreate_3.webp) APIが作成されると、コンソールに通知が届きます。APIは_API Gateway_ページに一覧表示されます。 ![apig_autocreate](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_autocreate_created.webp) これらのAPIに設定されたデフォルト値を編集し、要件に基づいて個別に設定できます。 このセクションで説明した通り、プロジェクトでホストされているWebクライアントに対してデフォルトの`Login Redirect API`も作成されます。 ![apig_login_redirect](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_login_redirect.webp) #### カスタムAPIの作成 カスタムAPIは、API Gatewayを有効にした直後、または自動作成を使用した後のいつでも作成できます。 関数またはWebクライアントのカスタムAPIを作成するには： 1. _API Gateway_ページから**Create API**をクリックします。 ![catalyst_apig_custom_create](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_custom_create.webp) API Gatewayを有効にした後のポップアップボックスで**Create a custom API**を選択し、**Next**をクリックして作成することもできます。 ![catalyst_apig_customcreate_1](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_1.webp) _Create API_ウィンドウが開きます。 ![catalyst_apig_customcreate_2](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_2.webp) 2. APIの一意の名前を入力します。[リクエストメソッド](https://docs.catalyst.zoho.com/ja/cloud-scale/help/api-gateway/key-concepts/#routing)を選択し、リクエストURLを入力します。 ![catalyst_apig_customcreate_3](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_3.webp) > **注意:** * Webクライアントには`GET`メソッドのみ選択できます。 * リクエストURLとリクエストメソッドの組み合わせは一意である必要があります。特定のリクエストURLとリクエストメソッドの組み合わせに対して複数のAPIを作成することはできません。 ターゲットコンポーネントを選択し、特定の関数またはWebクライアントを選択します。 ![](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_4.webp) Advanced I/O FunctionまたはWebクライアントを選択した場合、デフォルトのターゲットURLにルートを追加できます。リクエストURLのプレビューも表示されます。 ![catalyst_apig_customcreate_5](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_5.webp) 認証が必要な場合は、[認証方法](https://docs.catalyst.zoho.com/ja/cloud-scale/help/api-gateway/key-concepts/#authentication-request-processor)を選択します。これらの方法のいずれかまたはすべてを選択し、リクエストURLの提供時にいずれか1つを実装できます。 ![](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_6.webp) APIのスロットリング制限を設定します。[スロットリング方法](https://docs.catalyst.zoho.com/ja/cloud-scale/help/api-gateway/key-concepts/#throttling)のいずれかまたは両方を設定できます。 ![catalyst_apig_customcreate_7](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_7.webp) 3. **Create**をクリックします。 APIが作成され、_API Gateway_ページに一覧表示されます。 ![catalyst_apig_customcreate_created](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_created.webp) ### APIの編集 自動作成またはカスタムAPIはいつでも編集でき、以下の方法で定義を変更できます： 1. APIの**Edit**をクリックします。 ![catalyst_apig_edit_icon](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_edit_icon.webp) 2. 必要な値を変更し、**Update**をクリックします。 ![catalyst_apig_edit_api](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_edit_api.webp) ### APIの削除 以下の方法でAPIを削除できます： 1. APIの**Delete**をクリックします。 ![catalyst_apig_delete_api](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_delete_api.webp) 2. 確認ボックスで**Yes, Proceed**をクリックします。 ![catalyst_apig_delete_confirmation](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_delete_confirmation.webp) > **注意:** APIを削除すると、関連するターゲットURLにアクセスできなくなります。 ### API Gatewayの無効化 API Gatewayはいつでも無効にして、[Security Rules](https://docs.catalyst.zoho.com/ja/serverless/help/security-rules/introduction)で設定された定義に切り替えることができます。無効にした後にAPI Gatewayを再度有効にすると、作成済みのすべてのAPIは引き続き利用可能で、API Gatewayの再有効化時に直ちに再度有効になります。同じAPIを再度作成する必要はありません。 API Gatewayを無効にするには： 1. _API Gateway_ページの**省略記号アイコン**をクリックし、**Disable**をクリックします。 ![catalyst_apig_disable](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_disable.webp) 2. テキストボックスに「DISABLE」と入力し、**Confirm**をクリックします。 ![catalyst_apig_disable_confirmation](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_disable_confirmation.webp) API Gatewayが無効になり、Security Rulesが直ちに自動的に有効になります。