开放接口

功能介绍

数据来源

「开放接口」的数据来源于开放接口服务（如lamp-openapi），开放接口服务在依赖了sop-spring-boot-starter后，服务在启动时会扫描服务中所有标记了@Open注解的接口，将接口的元数据扫描后，通过dubbo接口调用sop-gateway-server服务的ApiRegisterServiceImpl#register方法，将所有接口信息存储到sop_api_info表。

注意

针对不同的接口，@Open(value="xx")一定需要保证唯一性。

界面操作

在界面上不能直接新增接口，接口数据只能自动扫描后存储进来。

1. 编辑

   该操作仅会修改数据库中的接口信息，下次重启时，会以代码中定义的信息重新覆盖数据库内容。

   若sop-gateway-server和lamp-openapi-server在运行时，接口信息被修改了，sdk调用该接口时，会实时生效。

2. 删除

   该操作仅会删除数据库中的接口信息，下次重启时，若代码中还存在同一接口，数据会被重新存储进来。

   若sop-gateway-server和lamp-openapi-server在运行时，接口被删除，sdk调用该接口时，也无法调用。

3. 查看

   查看接口的基本信息

字段说明

1. 应用名称

   该接口属于那个应用（服务）

2. 接口名称

   @Open(value="xx") 注解指定的接口唯一名称。

3. 版本号

   接口的版本号，对于相同接口名称的接口，可以通过 @Open(version="2.0") 升级版本。

4. 接口描述

5. 需要授权

   @Open(permission = true)

   该接口是否需要授权给ISV后ISV才能访问。 默认false。

   设置为true后，需要给ISV分组，然后在分组中绑定接口。

6. 需要token

   @Open(needToken = true)

   该接口是否需要token才能访问。 默认false。

   设置为true后，网关端会校验token是否存在。

7. 公共参数

   是否有公共响应参数,默认true。

8. 注册来源

   • 系统注册：服务启动时，自动扫描
   • 手动创建：在管理后台手动添加（暂不支持）

9. 接口模式

   • open接口：使用@Open标记的dubbo接口
   • restful接口：@OpenGroup 标记的接口 （不建议使用）

10. 状态

    接口的状态，禁用后接口将不允许被调用。