Working with API Gateway


Catalyst provides API Gateway as an advanced API management tool that enables you to create, maintain, and monitor HTTP requests generated from client applications and microservices. Catalyst API Gateway acts as an entryway into accessing the Basic I/O and Advanced I/O functions, as well as the web client components of your application.

To learn more about this component in detail, refer to the API Gateway help documentation .

The CLI provides options for you to perform the following actions in your application’s API Gateway:

  • Enable the API Gateway
  • Obtain the status of the API Gateway and schedule progress
  • Disable the API Gateway

After you enable the API Gateway for your project, you will be able to set up a JSON file in your project directory that contains the definitions of each API you create in your application. We will discuss this in detail in this help document. You can work on this JSON from the local environment and deploy it to the remote console , similar to the functions or client component.

You can also pull the latest API definitions created in your remote console to your local project directory, and update the API Gateway JSON file. You can learn about this from the Pull Resources help page.

Note: If you are a Visual Studio Code IDE user, you can install the Catalyst Tools extension, and perform CLI operations using your IDE in place of the CLI. Steps to work with API Gateway using Visual Studio Code IDE can be found here.

Last Updated 2024-01-09 17:07:13 +0530 +0530