服务注册
服务注册并不一定指注册一个微服务，它只是一个逻辑划分。可以简单的理解为一组具备业务关联的接口组成一个服务。服务注册好后，可给服务配置认证信息。若未给该服务下的接口特别指定认证信息，所有接口都会取服务上的认证信息进行接口透传。
- 菜单路径：
接口平台>接口配置>服务注册
列表字段：
- 所属租户：服务所属租户。
- 服务代码：服务代码，自行定义，同一租户下唯一，用于标识该服务。
- 服务名称：服务名称，自行定义。
- 服务地址：所有接口地址的公共部分。（服务地址 + 接口地址 = 注册接口访问地址）
- 服务类型：目前仅支持REST风格与SOAP风格两种服务。
- 状态：有启用禁用两种状态。
查询字段：
- 服务名称：服务的名称，支持模糊查询。
- 服务类型：服务的类型，可选REST与SOAP。
- 状态：服务启用与否。
- 所属租户：该服务所属租户。
- 服务代码：服务的代码，支持模糊查询。
点击
按钮可根据已有条件筛选出对应信息。
点击
按钮可重置查询条件。
操作列
删除：点击
按钮，可删除服务。
编辑：点击
按钮，可跳转到编辑页面对服务相关属性进行编辑。
服务认证
- 页面入口：
接口平台>接口配置>服务注册>点击编辑>点击服务认证
服务认证信息配置分为REST风格与SOAP分格
- REST 风格服务配置
| 认证模式 | 授权类型 | 认证用户名 | 认证密钥 | 客户端ID | 客户端密钥 | 获取TOKEN地址 | 处理方式 |
|---|---|---|---|---|---|---|---|
| NONE | - | - | - | - | - | - | 不做任何处理 |
| BASIC | - | 必填 | 必填 | - | - | - | 将用户名与密码用Base64加密作为头部认证信息 |
| OAUTH2 | CLIENT/PASSWORD | PASSWORD授权必填 | PASSWORD授权必填 | CLIENT授权必填 | CLIENT授权必填 | 必填 | 用给出的用户(客户端ID)/密码(客户端密钥)/获取TOKEN的Url生成的token作为头部认证信息 |
注意: 若对认证信息有特殊需要，我们在请求头部开放了两个参数AccessTokenHeader以及AccessTokenQueryParam。AccessTokenHeader用于将认证信息放在头部，其值代表认证信息在头部中的域。
AccessTokenQueryParam用于将认证信息放在请求参数里面，其值代表请求参数的key.
eg:
已知一个能访问的外部系统接口TEST_ITF，服务代码未TEST_SERVICE,完整访问路径如下:
http://www.test.com/apiInfo?extern_system_access_key=UUID
那么通过接口平台访问的时候，由上面的表格处理知道，认证信息均在头部不满足需要，所以
我们可以这样访问发布地址：
POST /v1/rest/invoke?organizationId=0&serverCode=TEST_SERVICE&interfaceCode=TEST_ITF
{
“headerParamMap”:{“AccessTokenQueryParam”,“extern_system_access_key”}
}
- SOAP 认证配置
SOAP认证配置，只需要配置好加密类型、校验用户名、校验密码即可。
接口新建
- 页面入口：
接口平台>接口配置>服务注册>点击编辑>点击新建
字段介绍：
- 接口编码，自行定义同一服务下唯一。
- 接口地址：访问服务下接口的地址。（服务地址+接口地址 = 完整地址）
- 请求方式：若为REST风格必填，否则执行会提示报错。SOAP风格不填。
- 发布类型：REST、SOAP风格二选一，REST风格接口可发布成SOAP接口，反之亦可。
- 映射类： 对于基于接口平台开发扩展类，他提供了对请求体与响应体装饰的能力。 该类需要继承自BaseTransferDataConverter
- 状态：正常，可一直使用，失效，接口无法使用，窗口期：接口使用时间段。
- 发布地址： 系统自动生成，外部系统通过发布地址调用注册的接口才可以使用接口平台相关功能
注意：接口可单独配置认证信息，具体可参考本目录的接口汇总能力查询
接口文档
- 页面入口：
接口平台>接口配置>服务注册>点击编辑接口文档
参数信息：
- 请求头部：请求头部等价于HTTP协议头部，在这里可以指定当前请求使用头部信息。
- GET/URL参数：指GET方式或则POST方式URL中？后面的参数部分。
- BODY参数： 只有使用POST方式的时候，此参数才有效。Body分为application/x-www-form-urlencoded、text/xml、application/json、raw类型。暂时不支持multipart/form-data
- 响应头部： 用户自行定义
- 返回头部： 用户自行定义
注意： 非基本类型可编辑参数候选值，一旦候选值确定。用例便只能从候选值里面取数据。
测试用例
测试用例提供一键生成、一键执行、代码预览等功能。
- 页面入口：
接口平台>接口配置>服务注册>点击编辑接口文档>点击测试用例
列表字段：
- 用例名称： 系统自动生成，可编辑。
- 用例类型： 通用、健康检查等、LOV选择。
- 说明： 可自行编辑
操作列：
- 编辑： 可编辑上述列表字段，也可编辑相关参数值。
- 执行： 每次执行都会去调用一次注册的接口。
- 查看历史： 可查看执行的情况。
- 代码预览： 可生成调用发布地址的方式。包括java的SDK方式、HTTP方式、CURL方式
- 删除： 点击可删除测试用例
