Chapter ten find and record the REST API

第十章 发现和记录 REST API

This chapter discusses how to discover what is available on an instance REST service and how to REST The service generates documentation.

使用 /api/mgmnt 服务发现 REST 服务

/api/mgmnt Services include available for discovery REST Service class and enable REST 的 Web 应用程序的调用.

发现 REST 服务

要使用 /api/mgmnt service to discover what's available on the instance REST 服务,请使用以下 REST 调用：

• 对于 HTTP 操作,选择或指定 GET.
• 对于 URL,请指定以下形式的 URL：

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

或者,If you want to check only one namespace：

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

其中 localhost 是服务器的名称,52773 是运行 IRIS 的 Web 服务器端口,namespace is the namespace to check.

（请注意,These calls ignore hand-coded ones REST 服务.To discover the manual coding REST 应用程序,请使用调用 GET /api/mgmnt/ 和 GET /api/mgmnt/:v1/:namespace/restapps.）

如果调用成功,IRIS 以 JSON format returns a list REST array of services.例如：

[
  {
    
    "name": "%Api.Mgmnt.v2",
    "webApplications": "/api/mgmnt",
    "dispatchClass": "%Api.Mgmnt.v2.disp",
    "namespace": "%SYS",
    "swaggerSpec": "/api/mgmnt/v2/%25SYS/%Api.Mgmnt.v2"
  },
  {
    
    "name": "myapp",
    "webApplications": "/api/myapp",
    "dispatchClass": "myapp.disp",
    "namespace": "USER",
    "swaggerSpec": "/api/mgmnt/v2/USER/myapp"
  }
]

发现支持 REST 的 Web 应用程序

要使用 /api/mgmnt service to discover the support available on the instance REST 的 Web 应用程序,请使用以下 REST 调用：

• 对于 HTTP 操作,选择或指定 GET.
• 对于 URL,请指定以下形式的 URL：

http://localhost:52773/api/mgmnt

或者,If you want to check only one namespace：

http://localhost:52773/api/mgmnt/v1/:namespace/restapps

其中 localhost 是服务器的名称,52773 是运行 IRIS 的 Web 服务器端口,namespace is the namespace to check.

使用 %REST.API 类发现 REST 服务

%REST.API Classes available for discovery REST Service class and enable REST 的 Web 应用程序的方法.

发现 REST 服务类

要使用 %REST.API class to discover what's available on the instance REST 服务,Please use the following methods of this class：

• GetAllRESTApps()

GetAllRESTApps(Output appList As %ListOfObjects) as %Status

Returns on this server REST List of services as output.输出参数 applist 是 %ListOfObjects 的实例,Every item in the list is %REST.Application 的实例,其中包含有关 REST 服务的信息.This includes no association Web any application REST 服务.This method ignores any manual encoding REST 服务.

• GetRESTApps()

GetRESTApps(namespace as %String,
            Output appList As %ListOfObjects) as %Status

Returns in the namespace indicated by namespace as output REST 服务列表.

发现支持 REST 的 Web 应用程序

要使用 %REST.API class to discover the support available on the instance REST 的 Web 应用程序,Please use the following methods of this class：

• GetAllWebRESTApps()

GetAllWebRESTApps(Output appList As %ListOfObjects) as %Status

Returns enabled on this server REST 的 Web List of applications as output.输出参数 applist 是 %ListOfObjects 的实例,Every item in the list is %REST.Application 的实例,其中包含有关 Web 应用程序的信息.

• GetWebRESTApps()

GetWebRESTApps(namespace as %String,
               Output appList As %ListOfObjects) as %Status

作为输出,Returns support in the namespace indicated by the namespace REST 的 Web 应用程序的列表.请参阅 GetAllWebRESTApps().

为 REST The service provides documentation

记录任何 API 很有用,so that it can be easily used by developers API.对于遵循 OpenAPI 2.0 规范的 REST API,可以使用 Swagger Open source frameworks are yours according to the content of the specification API Provides interactive documentation.

一种选择是使用 Swagger UI and provide a hosted copy of the documentation.对于演示：

1. 转到 https://swagger.io/tools/swagger-ui/
2. 单击 Live Demo
3. in the box at the top of the page,以 JSON 格式输入 REST 服务的 OpenAPI 2.0 规范的 URL.

例如,在 IRIS 服务器上使用 GET/api/mgmnt/v2/:namespace/:application 调用.

4. The document is then displayed in the lower part of the page,如以下示例所示：

在这里,Detailed information about each call can be viewed、Test the call and see the response.

Other third-party tools enable static generation HTML. There is no specific recommendation for this.