Creating a custom REST API

You can use the following documentation as a basis for creating your own custom REST APIs.

REST API designs
Before you start developing REST APIs, ensure that you read through the design principles and design basics to ensure good REST API design.
Analyzing the REST APIs
Before you start developing REST APIs, ensure that you do a gap analysis on the existing REST APIs. You should also do a gap analysis of the existing Cúram functionality to determine the correct domain definitions to use for your resource representation. In addition, this gap analysis might identify any existing APIs within Cúram that can be used to implement the functionality of the new REST APIs.
Modeling the REST APIs
When you complete the REST API design, you must use IBM Rational Software Architect to model the facade, operations and structs.
Implementing the REST APIs
After the modeling is complete, you need to generate the Cúram model. Refer to the appendix section for details on how to implement the facade methods that are created for the IBM Cúram REST API accelerator.
Configuring the resource configuration files
You must create a REST configuration file in XML format to define the mapping of the REST resource paths to the Cúram façade operations.
Building and testing REST APIs
After you model the facades and create the REST configuration file, you need to generate and test the REST APIs.
Integrating with a mobile application
You can integrate the Cúram REST APIs with other applications, either within your enterprise or with external systems. In this accelerator, the Cúram REST APIs are integrated with a mobile application.