Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. In the Management Console, click the Main tab.

  2. Under Manage -> Service Bus, click APIs.
    The Deployed APIs dialog appears, displaying the APIs you've already created.  Before you create a new API, you should browse the list to see whether an API already exists that will suit your needs. You can easily find an existing API by entering all or part of its name in the Search field and then clicking the Search icon.
  3. Click Add API.

    The Add API dialog appears.

  4. Specify the following:
    • A unique name for this API.
    • The context, and optionally the hostname and port (see Specifying the context for more information).
  5. Click Add Resource, and then scroll down to see the additional fields.
  6. Specify the HTTP method to use for this invocation (see Best practices for designing REST APIs for more information).
  7. In the URL Style list, select whether you're specifying a URL mapping or URI template, and then specify the pattern in the box that appears (see Using patterns with resources for more information). 
  8. Specify the In, Out, and Fault sequences as needed by taking one of the following approaches for each:
    • To omit the sequence, leave it set to None.
    • To create a new sequence, click Define Inline, click Create, and then define the sequence as described in Adding a Mediation Sequence.
    • To use an existing sequence in the registry, click Pick From Registry, and then select the sequence from the local, Configuration, or Governance registry (see Working with the Registry).
    • To use an existing sequence in the Synapse configuration, click Use Existing Sequence and select it from the drop-down list.
  9. Click Update to apply the resource to the configuration.
  10. Click Add Resource again and repeat these steps to add additional resources as needed. When you have finished defining the API, click Save.

...