Create a Service from a specification

To create a Service from a specification:
  1. From the left navigation pane, open the Services Catalog page.
  2. Click the dropdown arrow next to the Add Service button and select Add service from spec. The panel opens:

    The Create Service from a spec panel

  3. Click the Project field and select the project to save the generated Service in.
  4. Add the specification (JSON or YAML) in one of the following ways:
    • Click Upload spec to upload the file from your local folder.
    • Paste the spec URL into the URL field.
  5. Under Endpoint generation, choose what happens for each path in the specification:
    • External: Generate external endpoints from the paths in the specification. Each endpoint calls an upstream service, so no pipelines or tasks are created.
    • Native: Generate a starter pipeline and a task for the endpoints you select.
  6. If you selected Native, click the Server field and select the Snaplex to run the generated tasks.
  7. Depending on your Endpoint generation choice:
    • If you selected External: Click Create. APIM 3.0 creates your Service, and this procedure is complete. The Service opens for your review.
    • If you selected Native, click Next: Review endpoints and continue with the following steps.
  8. On the Review endpoints screen, review the specification endpoints. Each row groups the paths for one resource and shows the pipeline and task names that APIM 3.0 will create for it.

    Review endpoints screen listing endpoints with their paths, task types, and Snaplexes

  9. Clear the checkbox next to any endpoint you don't want to generate a pipeline and task for.
  10. For each selected endpoint, set the Task Type (Triggered or Ultra) and, if needed, override the Snaplex to run the task.
    To apply the same task type to every endpoint, click Triggered or Ultra next to Set all task types.
  11. Click Create service & generate.
    APIM 3.0 creates your Service and generates a pipeline and task for each selected endpoint. The Service opens so that you can review generated pipelines and tasks, including a View pipeline link and a generation status for each.

If you generated native endpoints, open each resulting pipeline and modify as necessary. For example, add the appropriate account. Check the endpoints and apply the appropriate Policies, and you are ready to test.

If you generated external endpoints, open each endpoint and check its upstream URL. A specification's server URL is optional, so if your specification doesn't include one, set the upstream URL for each endpoint.