API First implementation with Integration Server

Before you begin

  • Ensure that you have the Manage API privilege.
  • Configure the required Integration Server instances in webMethods API Gateway for implementing your APIs.

About this task

When an API created in webMethods API Gateway is implemented in Integration Server, then the API Contract is sent from webMethods API Gateway to Integration Server.

In this example, the APIFirst API is created in webMethods API Gateway and implemented in the Integration Server instance, IS1 that is configured in webMethods API Gateway.

Procedure

  1. Open the menu options and select APIs.
  2. Click Create API to create an API with required API documentation.
  3. Click Policies and define required policies for the API.
  4. Click Enable mocking to generate API mock responses.
    The API can now send responses to the requests that it receives from consumers.
  5. From the APIs page, click Publish for the APIFirst API.
    The Publish API dialog box appears.
  6. Select Integration Servers.
    The list of configured Integration Servers instances appears.
  7. Select the IS1 instance from the list.
  8. In the Package Name and Folder Name fields, provide the package name and folder name of the IS instance in which the API must be implemented.
    The API along with the API contract is published to Integration Server.
  9. After you implement the API in Integration Server, invoke the REST end point to communicate the API-implemented endpoint to webMethods API Gateway:
    PUT http://<webMethods API Gateway host>:<port>/rest/apigateway/apis/{apiId}/implementation
    {
    "maturityState": "string",
    "nativeBaseURLs": [
    "string"
    ]
    }

    You can provide required values for the parameters in the above command.

    Example

    
    PUT http://10.2.151.149:5555/rest/apigateway/apis/
    94dfd243-dd54-4d7e-8ba5-396ffaf6fe4e/implementation
    {
    "nativeBaseURLs":["https://10.2.35.125:5556/ws/srvs:Calculator/
    CalculatorHttpSoap11Endpoint",
    "http://10.2.151.149:5555/ws/srvs:Calculator/CalculatorHttpSoap11Endpoint"],
    "maturityStatus" : "Implemented"
    }

    As a result of the REST call, the mocking of the API is disabled and the consumers requests are directed to the actual implementation.