How to Define REST Interfaces in InterSystems IRIS

How to Define REST Interfaces in InterSystems IRISCopy link to this section

There are two ways to define REST interfaces in InterSystems IRIS:

• Define an OpenAPI 2.0 specification and then use the API Management tools to generate the code for the REST interface.

• Manually code the REST interface, then define a web application in the Management Portal.

This First Look shows how to manually code the REST interface, including developing a dispatch class. If you prefer to use the specification-first method, these dispatch classes are generated automatically and should not be edited. Advantages of using the specification-first definition include the ability to automatically generate documentation and client code from the specification, but you can use either way to define REST interfaces. For more information about defining REST interfaces using a specification, see Creating Rest Services.