接口管理

接口列表

接口分组管理这里就不在叙述，就是为了给接口归类。

上图为接口列表页，左上角有两个按钮，一个是新增接口，一个是接口文档跳转按钮。

数据列表中 第1列为 接口名称，第2列为接口分组，第3列为接口请求类型，OneBase默认统一POST类型，当然需要其他类型如GET 可自行扩展，第4列为接口地址也就是 （控制器/方法），第5列是接口目前的状态，接口状态中的选项在系统设置的API栏目下可进行配置，第6列为研发者，研发者成员也在系统设置的API栏目下配置，后面两列为接口排序与操作，接口排序为同级有效。

接口新增

^_^。 虽然表单数据数据有点多，但是不要怕蛤，咱们来一个一个讲解。

咱们按从左往右，从上往下进行编号讲解，比如 1 2 3 4 对应的是 接口名称，接口排序值，请求地址，请求类型。

1：API接口名称，就是用来看滴。。

2：接口排序值，用来进行接口显示排序，这些都很好理解啦。

3：请求地址，接口访问地址格式（控制器/方法）。

4：请求类型，默认为POST，需要其他类型可自己扩展。

5：是否为分页接口，意思就是这个接口是否需要分页功能，如果需要分页功能可传递相关参数，如：list_rows 每页显示的数据量，page 查询的页码。

6：研发者，此接口的研发人员，选项中的可选值可在系统设置的API分组下进行配置。

7：请求数据，意思就是执行此接口是否需要带请求参数，默认为否不带请求数据，此处的请求数据控制的为接口所依赖的请求参数，大家可以打开 https://onebase.org/api.php 看到里面这些接口 下面有个测试接口功能，此处测试接口功能的表单就是根据这里请求数据设置自动生成的，Token与分页参数是不受此处控制的。

8：响应数据，意思就是接口执行成功后返回的数据，默认为否不带返回数据，为是 则可添加接口返回的数据，当然也会有特殊数据 如 分页数据及后面将介绍的数据签名 等。

9：接口分组，这个就不介绍啦。

10：接口状态，这个也飘过吧。

11：接口响应示例，这个是用来给接口调用者看的，方便接口调用者可一眼看清数据结构，提升团队研发效率。

12：接口简介，用来看滴。

13：是否验证用户令牌：user_token， 用来做身份验证滴，比如 文章列表接口，所有的访问者不需要登录也可以看到，就设置为否，这样接口调用就不需要带user_token，若 为需要身份验证的接口，如 订单列表，某个会员只能查看自己的订单，就需要用到user_token啦，所以 像 订单管理，个人中心等 这些接口是需要带 user_token的。user_token 是调用登录接口后返回的，所以若终端想调用需要身份验证的接口，则需要 先调用登录接口后将接口中返回的 user_token 保存下来，在后续接口调用过程中使用。

14：是否响应数据签名：data_sign，此处是用于做数据安全验证的，比如咱们服务器给终端返回了数据，但是 终端那边怎么知道真滴是咱们返回的呢。。此时 data_sign 就派上用场啦。 返回的数据中带上了 data_sign 字段，终端根据服务器返回的数据进行与服务器端相同的算法，计算出 终端的 data_sign，然后两端的 data_sign 进行比对，若一模一样，则说明 数据是一模一样滴，这样就很安全啦，别人想改也不行，嘿嘿。

15：是否验证请求数据签名：data_sign，原理是一样滴，意思就是 终端像接口提交数据时，咱们服务器端也得知道提交的数据是否安全，所以 咱们也要根据提交上来的数据 生成 data_sign，与提交数据中带的data_sign，进行比对，不一样的话就不执行操作，接口返回数据签名不对，一样的话就放行。

16：这个是备用的。。担心服务端人员太腻害，研发出来的接口实在是用言语无法表达。。就可以用富文本进行图文描述。。

好啦，输入选项介绍完了，咱们看下登录接口的编辑数据页面，看看是咋输入滴。

后台接口管理功能就介绍到这里，更深一步将在接口研发中讲解。