跳到主要内容

注册第一个API

API（应用程序编程接口）是允许不同软件系统之间进行通信的标准化的接口，用于实现系统间的数据交换和功能调用。

在TUS中，可以注册多种类型的API资源，支持以下协议：

  • HTTP
  • SOAP
  • gRPC
  • DUBBO
  • WebSocket

本文以HTTP类型API的注册过程做示例。

操作入口​

API注册有两个入口，如下图所示

入口1：

TUS注册API-操作入口1图示

入口2：

TUS注册API-操作入口2图示

注册API​

  1. 在弹出的选择API类型界面，选择"HTTP API"。
TUS注册API-选择API类型图示
  1. 在 "新建HTTP API" 页面的 "配置" 页签中填写 "基本信息"中的必填项，如下图所示：
TUS注册API-基本信息图示

请求路径为API的实际调用路径，需要以“/”开始，默认为前缀匹配方式（例：/http_api_demo 可以通过/http_api_demo/xxx 进行访问）；也可以通过勾选匹配全路径选项开启路径精确匹配，开启后仅能通过基础路径（/http_api_demo）访问该API。

选择请求方法，可选请求方法为：GET、PUT、POST、DELETE、HEAD、OPTIONS、TRACE、PATCH，指定为ANY表示可以使用任意请求方法调用该API，但需要被代理的接口支持相应的请求方法。

  1. 新建HTTP API-->配置-->后端配置
TUS注册API-后端配置图示
  1. 切换到"管理"页面
TUS注册API-管理页面图示

点击“注册”按钮

TUS注册API-注册图示

点击“通过”按钮

TUS注册API-注册通过图示

点击“部署”按钮

TUS注册API-部署图示

点击“测试”按钮

TUS注册API-测试图示
  1. 打开：运行管理-->API运行管理
TUS注册API-API运行管理图示