关于API
Taurus提供两种形式的API，RSocket和REST。REST接口一般用于文件上传下载，第三方对接等；其他功能均通过RSocket接口输出。
RSocket接口说明
交互模型
- Request Response(rr): 请求单独的响应体
- Request Stream(rs): 获取一个数据流
- Request Channel(rc): 请求响应为双向数据流
- Fire and Forget(fnf): 发送一个不需要任何响应(包括异常)的消息
访问限制
部分接口具有访问限制：
SPI: 仅允许在内网微服务之间发送请求，不允许通过网关的互联网请求CONSOLE: 仅允许管理控制台应用请求，不允许通过C端移动应用访问
通用错误码
| 错误码 | 说明 |
|---|---|
| 513 | 服务器内部错误 |
| 514 | RSocket请求被拒绝 |
| 515 | RSocket请求被取消 |
| 516 | 无效的RSocket请求 |
| 10400 | 请求参数错误 |
| 10401 | 用户验证错误 |
| 10403 | 请求被拒绝 |
| 10404 | 资源未找到 |
| 10419 | 资源冲突 |
REST接口说明
- GET, POST, PUT, DELETE
- 如何携带token
通用错误码
| 错误码 | 说明 |
|---|---|
| 200 | 正常返回 |
| 400 | 请求参数错误 |
| 401 | 用户验证错误 |
| 403 | 请求被拒绝 |
| 404 | 资源未找到 |
| 419 | 资源冲突 |
返回结果类型
接口返回类型有3种
- 单个数据结果为JSON对象
- 多个数据的列表结果为JSON数组
- 原始类型如布尔值，数值以及字符串等，为值本身
数据类型
请求参数以及返回结果的数据字段类型包括:
| 类型 | 说明 |
|---|---|
| Boolean | 布尔值 |
| Number | 数值类型，包括整数，浮点数 |
| String | 字符串, 其中日期类型在接口中也使用字符串表示, 格式为ISO8601日期字符串, 例如: 2021-08-09T03:39:28.924Z |
| Object | 对象 |
| String[] | 字符串数组 |
| Number[] | 数值数组 |
| Object[] | 对象数组 |
| Varies | 可变类型, 值可以是上述任何 一种类型 |