Help Center/ ROMA Connect/ User Guide/ Service Integration Guide/ Exposing an API/ (Optional) Creating an Environment and Variable
Updated on 2023-05-17 GMT+08:00
View PDF
Share

(Optional) Creating an Environment and Variable

An API can be called only after it is published in an environment. Publish it in different custom environments for development and testing. RELEASE is the system default environment for publishing APIs.

Environment variables are specific to environments. If environment variables are defined in backend information of an API, you need to add the variables to the corresponding environment. You can add variables in different environments to call different backend services using the same API.

Example: an API whose variable Path is defined in the backend request path. If variable Path is configured for environment 1 and is assigned value /Stage/test, use the backend request path /Stage/test to call this API in this environment. If variable Path is configured for environment 2 and is assigned value /Stage/AA, use the backend request path /Stage/AA to call this API in this environment.

Figure 1 Application of environment variables

Creating an Environment

  1. Log in to the ROMA Connect console. On the Instances page, click View Console of an instance.
  2. In the navigation pane on the left, choose API Connect > API Policies. On the Environments tab, click Create Environment.
  3. In the dialog box displayed, configure environment information and click OK.
    When a user needs to call an open API, APIs in the RELEASE environment will be called by default. To access an API in another environment, add the X-Stage parameter to the header of the API request, where the parameter is the environment name. For example, to access an API in the Develop environment, add X-Stage: Develop to the header of the API request.
    Table 1 Parameters for creating an environment

    Parameter

    Description

    Name

    Enter an environment name. It is recommended that you enter a name based on naming rules to facilitate search.

    Description

    Enter a brief description of the environment.

Creating an Environment Variable

  1. Log in to the ROMA Connect console. On the Instances page, click View Console of an instance.
  2. In the navigation pane on the left, choose API Connect > API Groups. Click the name of an API group to view details.
  3. In the Environment Variables area on the Group Information tab, select the environment to which you want to add variables, and click Add Environment Variable.
  4. In the dialog box displayed, configure environment variable information and click OK.
    Table 2 Parameters for creating an environment variable

    Parameter

    Description

    Name

    Enter the variable name, which must be the same as that defined in the API backend service information.

    Value

    Enter the value of the environment variable.
Parent topic: Exposing an API