模块

一级需求

二级需求

API开放门户

API资产门户

1、支持API数字资产分类展示，并支持类型、组织等条件搜索
2、API数字资产统计概览，从API资产数量，热度、贡献度、组织、个人等方面进行统计

API资产详情

1、API文档详情，包轮但不限于接口描述，版本，请求地址、请求必要参数、请求示例、备注等相关信息 。
2、支持查看历史版本的API文档。
3、支持API文档在线调试。

API订阅管理

1、支持应用(API消费者)的增删改查管理。
2、应用(消费者)订阅API管理，包括订阅申请、历史订阅信息管理、取消订阅等。

公告、使用教程，规范管理

1、支持发布公告
2、支持展示平台使用教程、规范。

API管理

API文档设计管理

1、API设计文档管理(包括但不限于新增,删除,修改,查询，分享,导入导出，外部swagger导入)
2、支持API版本管理，可选择不同版本的API查看对应文档。

接口mock测试

1、API设计完成后，可预设接口返回参数并提供API的mock测试。

API状态管理

1、支持API开发状态管理(待开发-开发中-已完成-已上线-已下线)

API对外提供能力服务

1、将API上架到API市场。

API调用权限管理

1、外部消费者：支持API市场消费者申请权限，后端进行审核通过后赋予权限。
2、内部消费者：支持管理端创建消费者，并批量赋予接口权限。
3、支持API的内/外部消费者调用权限管理(增删改查)。

API变更管理

1、对于API文档、状态、版本等信息变更前后，API负责人可进行邮件和站内通知到消费者。

API监控运维

1、对于API文档、状态、版本等信息变更前后，API负责人可进行邮件和站内通知到消费者。

API网关

概览

1、展示网关总体情况，包括当前网关已接入服务、接口等信息
2、网关性能监控

服务发现

1、支持常见注册中心进行服务注册2、手动填写地址进行服务注册
3、一个API网关可以纳管多个注册中心
4、注册中心管理

服务路由

1、动态路由：根据域名、Path、Method、Header、Query 等请求信息，将请求转发到不同的后端服务。
2、版本分流：后端服务存在多个版本，例如金丝雀发布，API 网关根据各版本的权重比例转发请求到不同版本。
3、负载均衡：后端服务存在多个服务实例，通过负载均衡算法，将请求转发到不同的实例。
4、服务预热：扩容和故障恢复场景，对于新加入的实例，支持在预热时间内逐步增加流量比例，防止突发大流量导致新启动服务实例异常
5、健康检查：通过动态探测后端服务实例健康状态，转发请求时将过滤掉不健康的服务实例，提升服务的可用性。
6、接口重试：当某个后端服务实例不可用返回异常响应，转发请求到该服务的其他实例进行请求处理，提升了服务的可用性。

认证授权

1、请求认证：校验请求调用方的合法身份，保证服务 API 仅被合法用户访问，提升服务的安全性。
2、基础鉴权：校验请求调用方是否有访问 API 的权限，拒绝未授权用户的访问，保证服务 API 仅被授权的合法用户访问，提升服务的安全性。

请求转换

1、协议转换：对常见接口协议进行转换。
2、参数转换：header 参数转换，请求参数转换，path重写
3、出参转换：对出参header 、返回体参数进行转换。

流量治理

1、限流控制：通过设置阈值控制服务接入流量
2、熔断、降级控制：支持服务熔断控制
3、缓存设置：指API 网关将请求的响应信息缓存起来，当下次有相同请求时，API 网关直接返回缓存的响应信息

安全防护

1、黑白名单：通过IP、Referer、UA、Header等信息配置API访问的黑白名单。
2、跨域处理：支持CORS、JSONP、WAF等跨域问题处理

插件管理

1、支持插件的方式对API功能进行加强。
2、支持自定义脚本编写插件。

其他

多租户管理

1、平台管理端支持多租户数据隔离
2、多个租户可以共享同一个网关实例，管理数据进行租户隔离

用户管理

1、用户基础信息管理
2、用户组织管理
3、角色管理
4、角色权限管理，可配置角色的菜单权限，功能权限。

平台操作日志审计

1、支持记录、查阅平台用户操作日志