Tutorial: REST Web Service

Walks you through the process of creating and 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.

Prerequisite

Review the Assumptions and Before you begin a tutorial sections in the Tutorials: Interface Mapping Toolkit topic to ensure that your Visual COBOL environment is set up properly.

Demonstration application - ScheduleDemo

The COBOL application that you use in this tutorial is the ScheduleDemo demonstration application. The application source code is installed with Visual COBOL in the %PUBLIC%\Documents\Micro Focus\Visual COBOL\Samples\Interface Mapping Toolkit\ServiceInterfaces\ScheduleDemo (Windows) or /opt/microfocus/VisualCOBOL/demo/imtk/scheduledemo (UNIX) directory by default.

The ScheduleDemo demonstration application is a system for scheduling and viewing appointments. The application uses the following source and data members:

  • schedule.cbl
  • common.cpy
  • common_78.cpy
  • common_ex.cpy
  • common_ws.cpy
  • consultants.cpy
  • customerinfo.cpy
  • stores.cpy
  • appoint.dat
  • consultants.dat
  • customers.dat

Using the application, you can either schedule a new appointment, or look up an existing appointment. We recommend that you review the application source code to become familiar with how it works.

Sequence

To complete this tutorial, progress through these topics in the order presented here. The bottom of each topic provides Next topic and Previous topic navigational links to help you proceed in the proper sequence:

  1. Set Up the ProgramREST Project
    Walks you through the process of creating a Visual COBOL project for the ScheduleDemo demonstration application and its REST Web service.
  2. Create the MakeCheckAppt Service Interface
    Walks you through the process of creating a REST service interface from the Schedule COBOL program.
  3. Define MakeCheckAppt Operations
    Provides step-by-step instructions that guide you through the process of defining four operations for the MakeCheckAppt service interface.
  4. Set Up the ESREST Enterprise Server Instance
    Walks you through the process of creating and configuring an enterprise server instance, ESREST, to use in this tutorial.
  5. Deploy the MakeCheckAppt Web Service
    Guides 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.
  6. Generate a COBOL Client
    Provides instructions for generating a COBOL client to access the MakeCheckAppt Web service.
  7. Debug the COBOL Client
    Guides you through the steps required to create a debug configuration for the COBOL console client application, and use the Eclipse debugger to run the client and access the MakeCheckAppt Web service.
Parent topic: Tutorials: Interface Mapping Toolkit
Related concepts
Tutorials: Interface Mapping Toolkit