Tutorial: JSON RESTful Web Service using API Resources

Walks you through the process of using the Interface Mapping Toolkit (IMTK) to define a JSON RESTful Web service for accessing resources, deploy it to an enterprise server instance, and invoke it with a request URI that results in a filtered output message.
Restriction: This topic applies only when the Enterprise Server feature is enabled.

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 - CarsProgram

The CarsProgram demonstration application is a system for tracking the vehicles available for purchase at a used car dealership. Using the application, you can access and modify the available vehicles.

The application source code and data file are installed with Visual COBOL in the $COBDIR/demo/Interface Mapping Toolkit/ServiceInterfaces/CarsProgram directory by default. They are:

  • CarsProgram.cbl
  • cars.cpy
  • cars.xml

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 ProgramRESTAPI Project
    Walks you through the process of creating a Visual COBOL project for the CarsProgram demonstration application, and populating the project with demonstration files.
  2. Create the CarTracker Service Interface
    Walks you through the process of creating the CarTracker service interface in which to define a JSON RESTful Web service.
  3. Generate CarTracker Operations
    Provides step-by-step instructions that guide you through the process of generating three operations for the CarTracker service interface.
  4. Set Up the ESRSTAPI Enterprise Server Instance
    Walks you through the process of creating and configuring an enterprise server instance, ESRSTAPI, to use in this tutorial.
  5. Deploy the CarTracker Web Service
    Guides you through the steps required to deploy the CarTracker Web service to the ESRSTAPI enterprise server, and verify the deployment results.
  6. Generate the CarTrackerClientApp COBOL Client
    Walks you through the process of setting client generation properties, generating a COBOL client to access the CarTracker RESTful Web service, and building the COBOL client project.
  7. Run the CarTrackerClientApp Client
    Guides you through the process of using a Web browser and the generated console client to access the CarTracker Web service, and how to make use of output filtering.
Parent topic: Tutorials: Interface Mapping Toolkit