Tutorial: Hello world

Walk through creating a pipeline, Triggered Task, and Service to publish a Hello World API on the Developer Portal.

Important: This page describes API Management 3.0, which models APIs as composable Services and applies governance with reusable Policies. For Classic APIM, refer to the Classic documentation.

This tutorial walks you through the process of using APIM 3.0 from creating a pipeline to publishing a Service on the Developer Portal.

Prerequisites

  • Understand the APIM 3.0 terms and concepts described in Getting started
  • An environment with APIM 3.0 enabled
  • Permissions to create and execute pipelines
  • A Snaplex
  • A published Developer Portal site
    Tip: If your environment doesn't have a published site, you can test the Service without publishing it.

Create the tutorial pipeline

First, create a simple pipeline that returns a Hello World message:

  1. Open Designer and drag a Mapper Snap onto the canvas.
  2. Click the Snap to open it.
  3. In the Mapping table Expression field, enter "Hello World of Services!". In the Target path field, enter $message.
    Mapper Snap example

  4. Save the Snap and run validation.
  5. Click the output view to confirm that the "Hello World of Services!" message displays.
  6. Edit the pipeline properties and change the name to Hello World of Services!.
  7. Click Save.

Create a Triggered Task

  1. In the Designer toolbar, click the Create Task icon and select Triggered Task:
    Create Task icon in the Designer toolbar with Triggered Task selected

  2. In the Name field, enter Trigger Hello World message.
  3. From the Pipeline dropdown, select Hello World of Services.
  4. From the Snaplex dropdown, select an available Snaplex.
  5. Optionally, enter your email to receive notifications.
  6. Click Save.

What's next?

Create the service.