Skip to content

Create API Proxy from Scratch

An API proxy acts as an intermediary between an existing API and API Platform, intercepting all requests made to the API.It also functions as a managed API, allowing you to apply essential API management features such as security policies and rate limiting.

Prerequisites

  • If you're signing in to the API Platform Console for the first time, create an organization:
    1. Go to API Platform Console and sign in using your preferred method.
    2. Enter a unique organization name. For example, Stark Industries.
    3. Read and accept the privacy policy and terms of use.
    4. Click Create.

This creates the organization and opens the Project Home page of the default project created for you.

Create an API Proxy

In this guide, you will create an API proxy from the Scratch.

  1. Go to API Platform Console and sign in. This opens the project home page.
  2. If you already have one or more components in your project, click + Create. Otherwise, proceed to the next step.
  3. Select Start from Scratch.

  4. Specify the following values as API proxy details:

    Field Value
    Name Department Service
    Identifier department-service
    Version 1.0
    Base Path /default/department-service/v1.0
    Description Sample proxy for department service
    Target https://samples.choreoapps.dev/company/hr
    Access Mode External

  5. Click Create to create the API Proxy. Wait for the setup to complete.

Configure and Deploy the API Proxy

  1. Navigate to the Deploy page of the API Proxy.
  2. Select Configure and Deploy option from the Deploy dropdown and click Configure and Deploy button.
  3. Select External as API Access Mode.
  4. Click Deploy.

Test the API Proxy

  1. Navigate to the Test → Console page of the API Proxy.
  2. Use the OpenAPI Console to test the API Proxy.

Promote the API Proxy to Production and Publish the API Proxy

  1. Navigate to the Deploy page of the API Proxy.
  2. Click Promote. This promotes the API proxy from the Development environment to the Production environment.
  3. In the left navigation menu, click Lifecycle under Develop. This takes you to the Lifecycle page.
  4. Click Publish.
  5. In the Publish API dialog, click Confirm to proceed with publishing the API. If you want to change the display name, make the necessary changes and then click Confirm. This sets the API lifecycle state to Published.