Tutorial: REST Web Service

Walks you through the process of defining a Representational State Transfer (REST) Web service using the Interface Mapping Toolkit (IMTK), deploying it to an enterprise server instance, and generating and running a client to access it.
Restriction: This topic applies only when the Enterprise Server feature is enabled.
Restriction: This topic applies to Windows environments (local development) only.

Before You Begin

Before beginning this tutorial, be sure that you have completed all tasks outlined in the Prerequisites section of the Tutorials: Interface Mapping Toolkit topic.

Overview

In this tutorial, you work through the following tasks:

  • Review the code in the COBOL demonstration application to become familiar with how it works
  • Create, configure, and populate an Eclipse project.
  • Using the Interface Mapping Toolkit (IMTK), define a SOAP Web Service to access the COBOL application
  • Create and configure an enterprise server instance on which to run the SOAP Web service.
  • Deploy the Web service to the enterprise server
  • Generate a COBOL client to access the Web service
  • Run the COBOL client to debug the Web service

Sequence

Complete this tutorial by following the instructions in the following topics in the order listed here. The bottom of each topic provides Previous topic and Next topic navigational links to help you proceed through the tutorial in its proper sequence:

  1. Demonstration Application
    Describes the ScheduleDemo application used in this tutorial.
  2. Create the ProgramREST Project
    Walks you through the process of creating a Visual COBOL project for the ScheduleDemo demonstration application and its REST Web service.
  3. Set Build Configuration Properties for ProgramREST
    Walks you through the process of setting Build Configuration properties for the ProgramREST project.
  4. Add Demonstration Files to ProgramREST
    Walks you through the process of adding ScheduleDemo demonstration files to the ProgramREST project.
  5. Create a REST Web Service
    Walks you through the process of creating a REST Web service for the ScheduleDemo application.
  6. Define Service Interface Operations
    Walks you through the process of defining the service interface details for the ScheduleDemo application.
  7. Create and Configure ESREST
    Walks you through the process of creating and configuring an enterprise server instance, ESREST, to use in this tutorial.
  8. Deploy the REST Web Service
    Walks you through the steps required to prepare the ProgramREST project and MakeCheckAppt Web service for deployment, deploy the Web service to the ESREST enterprise server, and verify the deployment results.
  9. Generate a COBOL Client
    Walks you through the process of generating a COBOL client for the MakeCheckAppt service interface.
  10. Prepare to Debug
    Walks you through the process of creating a Debug Configuration and setting break points.
  11. Run the COBOL Client
    Walks you through the process of running the COBOL client application to debug the Web service.
Parent topic: Tutorials: Interface Mapping Toolkit
Related concepts
Tutorials: Interface Mapping Toolkit