rfns / FirstLook-REST

This sample shows you how to work with and develop REST interfaces in InterSystems IRIS to access databases and productions.

This is the README file for FirstLook-REST. The end of the file has setup instructions.

Use or operation of this code is subject to acceptance of the license available in the code repository for this code.

FirstLook-REST is meant for use with the InterSystems IRIS Data Platform. This code sample is intended to be used with "First Look: Developing REST Interfaces in InterSystems IRIS".

The sample shows you how to develop REST interfaces in InterSystems IRIS to access databases and productions. You can use these REST interfaces with UI tools, such as Angular, to provide a user interface to databases and interoperability productions. You can also use them to enable external systems to access InterSystems IRIS applications.

The sample defines a database of coffee makers and provides REST interfaces to access them.

---

Setup instructions

---

Detailed instructions to use this sample code are provided in First Look: Developing REST Interfaces in InterSystems IRIS.

A summary of the steps to run the sample follow:

1. Clone or download the repository. If you download a zip archive, extract the files in the archive.

2. Open the InterSystems IRIS Terminal.

3. Enter the following command (replacing mynamespace with the namespace where you want to load the sample):

   ZN "mynamespace"

4. Enter the following commands (replacing with the full path of the buildsample/Build.RESTSample.cls file):

   do $system.OBJ.Load("full-path-to-Build.RESTSample.cls","ck")

   do ##class(Build.RESTSample).Build()

5. When prompted, enter the the full path of the directory to which you downloaded this sample. The method then loads and compiles the code and performs other needed setup steps.

6. Copy the coffee directory of the repository to install-dir/CSP.

7. In the Management Portal, create a web application named /coffee

   This will use the install-dir/CSP/coffee directory.

8. Create another web application, this one named /rest/coffeemakerapp. See First Look: Developing REST Interfaces in InterSystems IRIS for details.

9. Use a REST tool, such as Postman, to enter the REST calls.