Skip to main content Skip to complementary content

Creating the API

Create your API and its operations to manage them in Azure. In this example the operations are created manually, but you can also import an API definition from Talend Cloud API Designer. For more information, see Deploying an API definition to Azure API Management.

Procedure

  1. Open the DemoREST-APIM instance you created and click APIs > Add API > Blank API.
  2. Click Full to show all the parameters available and configure the settings for your API as follows:
    Parameter Value
    Display name Enter a name for your API, DemoREST-API for example.
    Web service URL Enter the URL to the service. In this example, use the following URL and replace <DemoREST-PublicIP> with the public IP address associated with the load balancer you created: http://<DemoREST-PublicIP>:80/services.
    URL scheme Select the scheme defined in the load balancer, HTTP in this example.
    API URL suffix Enter the suffix to add to your API URL, services in this example.
    Products Select a product, Starter for example. This is required if you want to publish your API.
  3. Click Create.

    Example

    Create a blank API menu.
  4. Go to the Settings tab of your API, scroll down to Subscription and clear the Subscription required check box, then click Save.
  5. Go to the Design tab and click Add operation.
  6. Configure your first operation as follows:
    Parameter Value
    Display name Enter a name for your operation, Get all customers for example.
    URL Keep the default GET method and enter the endpoint for your operation, /customers in this example.
    Description Enter a description for the operation.
    Tags Enter a tag for the operation, customers for example.
  7. Click Save.
  8. Click Add operation to create another operation.
  9. Configure your second operation as follows:
    Parameter Value
    Display name Enter a name for your operation, Get a single customer for example.
    URL Keep the default GET method and enter the endpoint for your operation, /customers/{id} in this example.

    A new id parameter is automatically created in the Template tab.
    Description Enter a description for the operation.
    Tags Enter a tag for the operation, customers for example.
  10. In the Template tab, enter a description for the id parameter, Customer ID for example.

    Example

    In the APIs menu of the DemoREST-API, the new id parameter is available inside the template tab.
  11. Click Save.

Results

You have created an API with two operations. You can now test it using its new base URL.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here