Skip to content

03 快速入门

jinhongyang edited this page Apr 4, 2019 · 1 revision

创建分组

image 填写分组名称、备注选择权限即可添加完成

创建项目

image image 填写基本信息 image 填写配置环境

测试环境与正式环境的域名与 ip 是必填,Beta环境的选填,ip 支持多个

如何创建接口?

新建接口三步走:

  • 获取权限
  • 找到对应项目
  • 新建接口

获取权限

当前我们已经分配给各使用者对应项目的权限,后续权限申请只需找对应项目的组长即可。

选择项目

image

  1. 如果你已经登录,会在首页左侧看到一些项目组(默认选择第一个),并且在右侧罗列了该组的所有项目。
  2. 点击项目,进入该项目的详情页。

创建分类

image

新建接口

点击左侧接口分组右侧的菜单按钮,选择 添加接口,或者点击接口列表右上角的 添加接口image

添加基本信息

image

添加前端配置

image

添加后端配置

image

添加响应结果

image

恭喜你!创建了第一个接口,右侧即录入接口的信息预览。

image

接口管理

接口操作

接口发布(接口录入完毕之后,客户端即可再测试环境调用,返回mock数据,当接口发布测试之后,则透传到后端服务) 接口下线(当接口不再使用的时候,或者禁用的时候,可以将接口下线,实时生效) 接口关注 (关注接口之后,该接口的修改,发布,下线操作会以钉钉工作台的形势通知到您) 接口删除(必须所有接口都已经下线,才允许删除)

签名

什么时候接口需要签名

  1. 单纯提供给app的接口
  2. 给其他事业部或者给第三方提供接口

认证

网关实现了基于Token 的用户认证

什么时候需要认证

  1. 和当前用户相关的接口必须认证
  2. 一般情况下,凡是有写入用户数据的接口都是需要认证的(个别情况除外,比如浏览数等等),不认证既代表任何用户都可以无限制的注入数据

邀请团队成员

1. 确保成员已注册

邀请的团队成员,确保已经在平台注册登录过

2. 创建分组

image

请联系管理员创建分组,因为只有超级管理员才有权限创建分组,其他用户无法创建分组

3. 邀请分组团队成员加入

分组添加成功后,点击添加成员,邀请分组团队成员加入.添加成功后,被邀请的团队成员重新打开平台,就可看到该分组 image