SosoApi使用说明-基本操作文档

一、SosoApi基本操作

 

1、创建一个新项目

 

 

点击后弹出输入框，输入项目的名字。

 

开启：紧表明项目目前状况，只有开启和关闭两种状态。

 

点击保存，会自动跳转到项目列表页，就能看到我们刚刚创建的Soso项目。

 

 

在这里说明一下：

退出：是自己看不到这个项目了，而被添加到这个项目里的其他成员还是能看到的。

复制：没用过。

删除：指的是删除项目本身，删除后项目中的所有成员都看不到，只有管理员才有该权限，慎用。

 

2、编辑项目的基本信息

 

 

 

3、项目成员操作

 

点击项目成员，可以看到加入到这个项目中所有的成员列表

 

 

邀请成员分为两种

直接添加，可以设置成员的角色（管理员或者访客）

 

 

还可以通过邮件添加

 

 

注意：

成员列表中的编辑是不能够修改昵称的。

 

 

进入到编辑页面

 

 

这里只能修改的角色（管理员或访客），而且只有管理员才有权限修改。

如需修改个人的昵称，需要到个人中心去修改

 

 

4、关于项目变更

 

（1）包括变更通知和变更历史

 

 

列表中每个页面的右上角，都有变更通知，点击，都会出现，变更通知页面

 

 

没什么可说了，里边直接填写，或者限定给谁发送变更通知，内容的各种形式，都在这里填写。

 

（2）变更历史

 

就是发送变更的时候，所有选择保存到变更历史里边的所有变更。

进入的页面

 

 

可以很方便我们翻阅以前什么时候，做了什么操作。

 

5、API文档信息

 

访问主机，可配置为外网，局域网或本机ip，因为测试是基于本地的ajax请求， 所以只要API所在服务器处理好跨域请求都支持网站在线测试API。

 

 

在这里最主要的就是设置好根路径。

 

6、模块管理

 

步骤说明
主要用于对API接口进行分类，可以不设置，默认全部在"default"组下面。

注意事项
API文档预览展示的模块顺序为升序，如需按要求排序可在模块名称前加序号指定。

 

模块管理页面

 

 

新增和编辑的页面是一样的

 

 

定义模块的名称和权重，对这个模块加以描述

 

7、接口管理

 

首先我们要新增接口

 

 

进入接口新增输入页面

 

 

填写完成，并保存，返回接口管理列表页面

 

 

点击名称或者后边的编辑，都可以对我们的接口进行编辑。

进入编辑页面。页面分为三部分。基本信息，请求信息，响应信息

 

（1）基本信息

 

 

（2）请求信息

 

步骤说明
1.参数位置说明如下：
 

body：http请求body

cookie：本地cookie

formData：表单参数

header：http请求header

path：http请求url,如getInfo/{userId}

query：http请求拼接，如getInfo?userId={userId}

 

2.参数类型说明如下：
 

参考"编辑数据结构"步骤中的参数类型说明

自定义：目前仅支持自定义json格式，仅当"参数位置"为“body"有。

 

在我工作总我一般都用query，query类型在请求的时候，参数直接拼接到访问路径的后边

 

页面

 

 

点击更多，可以设置默认值，还有说明。

 

 

在页面添加完成，并保存，在预览中看到的结果出现在这里

 

 

（3）响应信息

 

步骤说明

1.数据类型说明如下：

参考"编辑数据结构"步骤中的参数类型说明

自定义：目前仅支持自定义json格式，仅当"参数位置"为“body"有效。

 

2.注意事项

指定默认响应时，只需将响应"编码"设置为"default"即可。

 

首先新增响应信息

 

 

我用到的定义响应信息有两种

第一，

类型选择自定义，把需要返回的json格式，定义到这个里边，完成

第二，

引用数据类型（ref），所引用的数据类型在数据结构中定义。

 

定义完成在接口中显示的位置为：

 

 

8、数据结构定义

 

首先新增数据结构，提供给上边的接口进行引用。

 

 

进入新增页面

 

 

字段可以是单类型字段，也可以引用其他定义的字段。