Chapter 2 using API Mgmnt service

Chapter two Use /api/mgmnt/ service

This chapter describes how to use /api/mgmnt Services to create 、 Update and delete REST service .

/api/mgmnt The service also provides services that can be used to discover and record Web Service options , As described later in this book .

Use /api/mgmnt Service creation REST service

establish REST The service recommendation method is REST Service creation OpenAPI 2.0（ Also known as Swagger） describe , And use it to generate REST Service . If you are implementing REST service , They may provide this OpenAPI 2.0 describe . of OpenAPI 2.0 Describe the details of the format , see also OpenAPI 2.0 standard . The following topics describe how to use /api/mgmnt Service to perform this operation .

Use /api/mgmnt Service generation class

First step , Generate REST Service , As shown below ：

1. With JSON Format creation or acquisition REST Service OpenAPI 2.0 describe .
2. obtain REST Testing tools , for example PostMan (https://www.getpostman.com/).
3. In the test tool , Create as follows HTTP The request message ：

• about HTTP operation , Select or specify POST.
• about URL, Please specify the following form URL：

http://localhost:52773/api/mgmnt/v2/namespace/myapp

among localhost Is the name of the server ,52773 Is to run IRIS Of Web Server port ,namespace Is to create REST The name space of the service ,myapp Is the name of the package in which the class is to be created .

• For request body , With JSON Format paste Web Service OpenAPI 2.0 describe .
• Specify the request body type as JSON (application/json)
• by IRISUsername and IRISPassword Parameters provide values . about IRISUsername, Specify a user , The user is %Developer Members of the role , And have read to the given namespace / Write access .

4. Send request message .

If the call succeeds , IRIS Create in a given package and namespace disp、impl and spec class .

5. In the test tool , Check the response message . If the request succeeds , The response message will be similar to the following example ：

{
    
    "msg": "New application myapp created"
}

To complete the basic REST service , Please create a Web Application and define the implementation . These steps can be performed in any order .

establish Web Applications

In this step , A provider will be created to REST Service access Web Applications . In the management portal , Complete the following steps ：

1. single click System Administration > Security > Applications > Web Applications.
2. Click create new Web Applications .
3. Specify the following values ：

• Name — Web Name of the application ; This is in this IRIS Must be unique in the instance . The most common names are based on running Web The namespace of the application ：/csp/namespace
• Namespace - Select the namespace in which the class is generated .
• Enable application Enable Application — Select this check box .
• Enable Enable — choice REST.
• Scheduling class Dispatch Class — Type the fully qualified name of the scheduling class . This should always be package.disp, among package Is the name of the package containing the generated class .

4. Click save .

Use /api/mgmnt Service update REST service

API Management tools enable you to update generated classes , Without changing the edits made in the implementation class . If necessary, , This class will be regenerated , But keep editing .

To update REST service , Please use “ Use /api/mgmnt Service generation class ” The steps listed in .

If the update is successful ,IRIS Will regenerate disp and spec Class and update impl class , Keep the edits made to this class . The response message will be similar to the following example ：

{
    
    "msg": "Application myapp updated"
}

How to update the implementation class

If you have edited impl class , These edits will be retained , As shown below ：

• The implementation of all methods remains the same .
• Any new class members added will remain intact .

however , The class and the description of each generated method will be regenerated （/// notes ）. If the signature of any implementation method changes （ for example , Because the specification has changed ）, The signature is updated and the following comments are added to the class method ：

/// WARNING: This method's signature has changed. 

Use /api/mgmnt Service deletion REST service

API Management tools also make it easy to delete REST service . So ：

1. Use REST Testing tools , establish HTTP The request message , As shown below ：

• about HTTP operation , Select or specify DELETE.
• about URL, Please specify the following form URL：

http://localhost:52773/api/mgmnt/v2/namespace/myapp

among localhost Is the name of the server ,52773 Is to run IRIS Of Web Server port ,namespace Is to create REST The name space of the service ,myapp Is included REST The name of the package of the service class .

• by IRISUsername and IRISPassword Parameters provide values . about IRISUsername, Specify a user , The user is %Developer Members of the role , And have read to the given namespace / Write access .

2. Send request message .

If the call succeeds ,IRIS Will delete... In the given package and namespace disp and spec class .

however , IRIS Does not delete impl class .

3. In the test tool , Check the response message . If the request succeeds , The response message will be similar to the following example ：

{
    "msg": "Application myapp deleted"
}

4. Manually delete the implementation class .

To be on the safe side ,/api/mgmnt The service will not automatically delete the implementation class , Because this class may contain a lot of customization .

5. This is before deletion 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 .