Configuring Environment Specific Parameters

When there are multiple environments, to allow easily configuring environment-specific details, apictl supports an additional parameter file named api_params.yaml. It is recommended to store the parameter file with the API Project; however, it can be stored anywhere as required.

After the file is placed in the project directory, the tool will auto-detect the parameters file upon running the import-api command and create an environment-based artifact for API Manager. If the api_params.yaml is not found in the project directory, the tool will lookup in the project’s base path and the current working directory.

The following is the structure of the parameter file.

environments:
    - name: <environment_name>
      endpoints:
          production:
              url: <production_endpoint_url>
              config:
                  retryTimeOut: <no_of_retries_before_suspension>
                  retryDelay: <retry_delay_in_ms>
                  factor: <suspension_factor>
          sandbox:
              url: <sandbox_endpoint_url>
              config:
                  retryTimeOut: <no_of_retries_before_suspension>
                  retryDelay: <retry_delay_in_ms>
                  factor: <suspension_factor>
      security:
          enabled: <whether_security_is_enabled>
          type: <endpoint_authentication_type_basic_or_digest>
          username: <endpoint_username>
          password: <endpoint_password>
      gatewayEnvironments:
          - <gateway_environment_name>           
      certs:
          - hostName: <endpoint_url>
            alias: <certificate_alias>
            path: <certificate_file_path>
      mutualSslCerts:
          - tierName: <subscription_tier_name>
            alias: <certificate_alias>
            path: <certificate_file_path>
The following code snippet contains sample configuration of the parameter file.

Example

environments:
    - name: dev
      endpoints:
          production:
              url: 'https://dev.wso2.com'
      security:
          enabled: true
          type: basic
          username: admin
          password: admin
      certs:
          - hostName: 'https://dev.wso2.com'
            alias: Dev
            path: ~/.certs/dev.pem 
      gatewayEnvironments:
          - Production and Sandbox    
    - name: test
      endpoints:
          production:
              url: 'https://test.wso2.com'
              config:
                  retryTimeOut: $RETRY
          sandbox:
              url: 'https://test.sandbox.wso2.com'
      security:
          enabled: true
          type: digest
          username: admin
          password: admin
    - name: production
      endpoints:
        production:
              url: 'https://prod.wso2.com'
        mutualSslCerts:
            - tierName: Unlimited
              alias: Prod1
              path: ~/.certs/prod1.crt
            - tierName: Gold
              alias: Prod2
              path: ~/.certs/prod2.crt

Instead of the default api_params.yaml, you can a provide custom parameter file using --params flag. A sample command will be as follows.

Example

apictl import-api -f dev/PhoneVerification_1.0.zip -e production --params /home/user/custom_params.yaml

Info

  • Production/Sandbox backends for each environment can be specified in the parameter file with additional configurations, such as timeouts.
  • Under the security field, if the enabled attribute is true, you must specify the username, password and the type (can be either only basic or digest). If the enabled attribute is false, then non of the security parameters will be set. If the enabled attribute is not set (blank), then the security parameters in api.yaml file will be considered.
  • Certificates (Endpoint certificates and MutualSSL certificates) for each URL can be configured in the parameter file. For certificates, a valid path to the certificate file is required.
  • The parameter file supports detecting environment variables during the API import process. You can use the usual notation. For example, url: $DEV_PROD_URL. If an environment variable is not set, the tool will fail. In addition, the system will also request for a set of required environment variables.
  • To learn about setting up different endpoint types such as HTTP/REST, HTTP/SOAP (with load balancing and failover), Dynamic and AWS Lambda, refer the section Configuring Different Endpoint Types.
Top