后端编码,依据不同场景下输入参数及测试数据,系统如何响应编写场景说明。
项目 | 描述 |
---|---|
标题 | 通讯场景名称,用于说明通讯场景用途, 可使用对应通讯接口+序号 |
名称 | 英文表示,可使用对应通讯接口+序号 |
子模块 | 选择通讯场景所属系统子模块 |
接口 | 选择通讯场景对应通讯接口 |
描述 | 用于说明通讯场景作用 |
详细说明 | 详细说明通讯接口请求过程, 包括验证内容,验证成功与否返回处理方式 |
输入实例 | 填写通讯接口所需输入参数 |
输出实例 | 根据通讯接口自动生成接口返回结构 Data 部分内容,除备注外,其余不可修改 |
测试地址 | 通过选择通讯接口自动生成通讯接口 请求测试地址,可修改 |
响应内容 | 点击【测试按钮】,返回通讯接口请求 返回完整结构内容 |
引用 | 弱关系 |
描述
- 属性:通讯接口输入参数,根据选择通讯接口自动生成,不可修改
- 类型:通讯接口输入参数类型,根据选择通讯接口自动生成,不可修改
- 值:填写对应通讯接口输入参数值,用于测试
- 备注:通讯接口输入参数备注,根据选择通讯接口自动生成,可修改
示例
- 标题:新建定级项目
- 名称:ProjectCreate
- 子模块:定级项目管理
- 接口:新建定级项目
- 描述:用于测试新建定级项目通讯接口
- 详细说明:
- 需要验证项目名称、项目编号、专家ID集合
- 验证通过执行操作,返回成功信息
- 验证不通过不执行操作返回验证失败信息
- 输入实例:见《附表:输入实例》
- 输出实例:无
- 测试地址:localhost:3128/none/api//LandGradingProject/ ProjectCreate
- 响应内容:见《附表:响应内容》
- 引用:无
附表:输入实例
属性 | 类型 | 值 | 备注 |
---|---|---|---|
Name | string | 南宁定级项目 | 定级项目名称 |
No | string | NN2017102901 | 定级项目编号 |
Description | string | 定级项目描述 | |
ExpertIds | IList | [1,3] | 专家ID集合 |
附表:响应内容
属性 | 值 |
---|---|
Success | true |
Info | |
Data | |
Code | 200 |