Creating APIs 201 – Finding out More

This page looks at creating APIs in more detail



Integration specialist concentrating on code

Developing REST-ful APIs is a skilled job

Requires coding expertise in programming languages such as Java, NodeJS, etc.

Requires deep understanding of REST concepts

Involves large training curve

Requires years of practice to master industry standards



We built it – so you don’t have to.

IBM App Connect has the knowledge and practices built in

  • Resource-centric API development

  • Guided experience to generate REST semantics

  • Auto generate URIs and URLs depending upon selected semantics

  • Auto generates industry level OpenAPI v2.0 document

  • Import user-defined OpenAPI docs and schemas (roadmap)

  • Supported on App Connect Toolkit

  • Auto generate request and respond body for your operation

App Connect Build API Screenshots



App Connect Creating an API Model Screenshot

You always start with Models

Models are the resources for your API operations

Create one or more models per API

Build model using a form based UI builder

(or import properties from your business app)

Model properties can be any of simple or complex data type

string, boolean, date, number, object, array of simple types, array of complex types



Next, Define Operations for your Models

choose from business semantics and let API Connect auto implements REST semantics

  • Create – POST
  • Retrieve – GET
  • Replace or Create – PUT
  • Delete – DELETE

implement filter parameters into your operations

by ID, by WHERE, pagination, etc

Defining Operations and then implementing them screenshots

Implement business logic for API operations using flow editor

click, drag and drop configuration – no coding!



API Operations and Implementation Screenshot

Implementing your business logic:

Use all of the usual API Connect Components

  • connectors
  • flow constructs
  • mapper
  • data transformation
  • POST=Create

    IBM App Connect does most of the heavy lifting



    Create the model as usual

    generates a sample request body

    auto-generates response body and status code

    offers guidance to support best practices

    GET by ID = Retrieve

    Retrieve by ID gets a single resource (think single record)



    Model has ID generated in URL

    Sample URL shown in flow

    Correct Status code and Response Generated

    GET by WHERE – if you don’t know the ID..

    Retrieve by ID gets a single resource (think single record)

    Uses Query Parameters in the URL – Automatically



    Allows you to pick non-ID fields as query parameters

    auto-generates Query Params

    handle filter parameters within flow logic

    GET with Pagination

    When there are a lot of records

    Allows multiple GETs to work down a result set



    supports skip, limit and token

    auto-generate query parameter, URL and REST syntax

    handle pagination parameters in flow logic

    PUT=UPDATE

    supports by ID, and by WHERE similar to GET operation

    PUT will strictly behave as REPLACE

    if you miss out on mapping/provide value for an optional field, it will be replaced with null

    Tip: make all fields in model as mandatory



    Custom API Operations

    your operation does not fit CRUD

    you do not agree with IBM convention

    or you are just not feeling that RESTy!





    Join The Discussion

    Your email address will not be published. Required fields are marked *