万维易源使用帮助手册
公有API管理的文档属于【API服务商】的范围(可以点此查看),在此我们只讨论【私有API】的管理。
#功能介绍:
本模块适用场景: 对于你在易源官网,上架接口以及接入点的过程中,需要配置的有:
对于调用者,要有请求参数列表, 返回参数列表,
对于你来说,重构一个请求参数列表给数据源接口,根据数据源返回的参数列表生成用户的返回参数列表
在此过程中,存在变量名不一致,结构不一样,数据源阻塞时,怎么动态切换另一个, mock返回等问题。
实现: 主要是ui化配置, 减少硬编程,只需要给每一个接入点配置一套固定的请求参数, 就能达到兼容地连接多个节点及其数据源, 并智能地在不同数据源间进行负载切换。解决了调用者到接口提供者到数据来源之间纷繁复杂的数据交互问题。 提供的功能包含但不限于: 请求参数映射, 接入点测试用例, mock数据, 熔断配置以及负载均衡。
#示例:
以[天气预报接口](https://www.showapi.com/api/lookPoint/9 "天气预报接口")举例, 简单了解一下专业名词的含义:
> -** 接口 **
- 天气预报
> -** 接入点**
> - 1, 坐标 -> 查询天气
>- 2,IP -> 查询天气
>- 3,地名 -> 查询天气
>- ...
>-**节点(数据源包装器)**
>- 1,a节点
- a节点的真实数据源
>- 2, b节点
- b节点的真实数据源
>- ...
```
{
接口:{
name: 天气预报,
接入点1: {
name: 坐标查天气,
// 有多个节点配置, 但同一时间仅有一个生效, 一个熔断之后才切换另一个
节点1: {
name: 节点一,
连接器: sql连接器, // 后面会专门讲解, 这里暂时将第三方的普通url接口视为url连接器
数据库查询语句: select * from...
... // 更多配置...
// 可配置多个数据源, 但同一时间仅有一个生效, 熔断才切换
数据源: {
数据库地址: xxx,
端口: xxx,
...
}
},
节点2: {
...
}
},
接入点2: {
name: ip查天气,
}
}
}
```
---
#配置项
首先了解一下接口创建页面提供的配置项
```
API名称: '天气预报'
同时创建接入点: '坐标查天气'
选择分类: '信息咨询' // 设置你的api属于哪一块, 将用于主站的分类
// 如果设置为私有,将只有指定的用户才可使用,且免费; 私有用户管理的tab里设置
API访问类型: 私有|公开
API付费类型: '收费' // 设置api访问类型为公开时,才有此选项
logo: // 设置该接口的图标
API描述: // 请提供一些稍完整的接口介绍信息 // 接入点描述信息在右侧tab'基本信息'中
```
