Chapter 4 use%rest API classes create rest services

Chapter four Use %REST.API Class creation REST service

This chapter describes how to use %REST.API Class to create 、 Update and delete REST service .

Use %REST.API Class creation or update REST service

establish REST The service recommendation method is from REST Service OpenAPI 2.0 Specification starts , And use it to generate REST Service . To use %REST.API Class to perform this operation ：

1. obtain REST Service OpenAPI 2.0 standard , use JSON Format , And save the specification as a file . The file must be UTF-8 Coded .
2. Before you want to define REST In the namespace of the service , Use this file to create %DynamicObject Example .
3. And then call %REST.API Class CreateApplication() Method . This method has the following signature ：

classmethod CreateApplication(applicationName As %String, 
                              swagger As %DynamicObject = "", 
                              ByRef features, 
                              Output newApplication As %Boolean, 
                              Output internalError As %Boolean) 
                              as %Status

• applicationName Is the name of the package in which the class is to be generated .
• swagger Represent OpenAPI 2.0 canonical %DynamicObject Example .

You can also specify this parameter as canonical URL、 The pathname or empty string of the file containing the specification .

• features - Must be passed by reference features It's a multidimensional array , It contains any additional options ：
  • If features("addPing") yes 1 And if the swagger It's an empty string , Then the generated class will contain a for testing purposes ping() Method .
  • If features("strict")i yes 1（ The default value is ）, that All properties in the specification will be checked . If features("strict")i by 0, Then only check the attributes required for code generation .
• newApplication Return as output , It's a Boolean value , Indicates that the method is to create a new application (true) Or update existing applications .
• internalError Return as output , It's a Boolean value , Indicates whether an internal error has occurred .

If this method generates a new application ,IRIS Will be created in the given package disp、impl and spec class .

If this method updates an existing application ,IRIS Will regenerate disp and spec Class and update impl class , Keep the edits made to this class .

If OpenAPI 2.0 Invalid specification , Then the method will not make any changes .

4. Create an access REST Service Web Applications , As in the front of this book “ establish Web Applications ” Described in .
5. according to “ Modify the implementation class ” The description in the chapter defines the implementation .

An example of the first step is shown below ：

 set file="c:/2downloads/petstore.json"
 set obj = ##class(%DynamicAbstractObject).%FromJSON(file)
 do ##class(%REST.API).CreateApplication("petstore",.obj,,.new,.error)
 //examine error and decide how to proceed...
 ... 

Use %REST.API Class deletion REST service

To use %REST.API Class deletion REST service ：

1. You can find REST In the namespace of the service , call %REST.API Class DeleteApplication() Method . This method has the following signature ：

classmethod DeleteApplication(applicationName As %String) as %Status

among applicationName Is included REST The name of the package of the service class .
2. （ Optional ） Manually delete the implementation class .

To be on the safe side , Class methods do not automatically delete implementation classes , Because this class may contain a lot of customization .

3. Delete this before REST Created by service Web Applications （ If there is ）. So ：

a. In the management portal , single click System Administration > Security > Applications > Web Applications.

b. On the list Web Click delete... In the row of the application .

c. Click OK to confirm the deletion .