前端和后端的通讯接口标准和期望正确的系统响应，约定接口输入参数和输出结果，还有验证规则要求，便于前端人员和后端人员编码一致。
| 项目 | 描述 |
|---|---|
| 标题 | 通讯接口名称，用于说明通讯接口用途 |
| 名称 | 英文表示，一般情况使用领域模型对应类名表示 |
| 子模块 | 选择通讯接口所属系统子模块 |
| 系统功能 | 选择通讯接口所属系统功能 |
| 数据表 | 用于自动生成代码，指定Execute方法中Dao类型 |
| 代码模板 | 用于自动生成代码选用模板，模板类型有以下5种 |
| 描述 | 用于表达通讯接口作用， 以及通讯接口请求过程（包括验证、返回成功与否）， 由于返回结构固定，若需要修改返回结构，需要在此说明 |
| 输入参数 | 填写通讯接口所需输入参数 |
| 输出参数 | 填写通讯接口返回结果参数，选用代码模板后， 会自动生成固定的输出参数结构 |
| 标准约束 | 填写通讯接口输入参数约束条件 |
| 引用 | 弱关系，较少场景需要使用 |
代码模板
- Query：一般用于查询列表数据时候选用，Execute方法执行后按照固定格式返回列表内容
- Get：一般用于查询单条数据时候选用，自动检验数据是否存在，Execute方法执行后返回内容
- Create：一般用于创建单条新数据时候选用，Execute方法执行后不返回内容
- Update：一般用于更新单条数据时候选用，自动检验数据是否存在，Execute方法执行后不返回内容
- Delete：一般用于删除单条数据时候选用，自动检验数据是否存在，Execute方法执行后不返回内容
描述
不要使用“当输入参数Key值不为空的时候根据输入值查询数据库字段【RecordNo】、【Address】、【Region】、【StreetName】，并返回结果”这样的说明，改为“基于Key检索备案号/地址/区域/街道”，【/】表示【或】关系，可使用【、】表示【与】关系。
输入参数
- 属性：英文表示，参数英文名称，使用骆驼命名法命名，首字母需大写
- 类型：选择属性对应的C#代码数据类型
- 备注：属性注释
输出参数
- Success：布朗类型，表示通讯接口结果返回成功与否，结构固定部分，一般不需进行修改
- Info：字符串类型，表示通讯接口结果返回信息，结构固定部分，一般不需进行修改
- Data：用户定义类型，表示通讯接口返回对象，通讯接口实际返回类型在这里进行修改
- Code：整型类型，表示通讯接口返回成功与否状态码，结构固定部分，一般不需进行修改
标准约束
- 属性：英文表示，参数英文名称，使用骆驼命名法命名，首字母需大写，对应输入参数属性名称
- 类型：选择属性对应的C#代码数据类型，对应输入参数属性类型
- 验证方式：包括非空、长度、正则表达式验证，允许多种验证方式组合使用
- 备注：对应验证方式的说明
示例
- 标题：新建定级项目
- 名称：ProjectCreate
- 子模块：定级项目管理
- 系统功能：新建定级项目
- 数据表：LandGradingProject
- 代码模板：Create
- 描述：用于保存新建定级项目
- 需要验证项目名称、项目编号、专家ID集合
- 验证通过执行操作，返回成功信息
- 验证不通过不执行操作返回验证失败信息
- 输入参数：见《附表：输入参数》
- 输出参数：见《附表：输出参数》
- 标准约束：见《附表：标准约束》
- 引用：无
附表：输入参数
| 属性 | 类型 | 备注 |
|---|---|---|
| Name | string | 定级项目名称 |
| No | string | 定级项目编号 |
| Description | string | 定级项目描述 |
| ExpertIds | IList | 专家ID集合 |
附表：输出参数
| 属性 | 类型 | 备注 |
|---|---|---|
| Success | bool | 返回成功与否 |
| Info | string | 返回信息 |
| Data | string | 返回数据 |
| Code | int | 返回状态码 |
附表：标准约束
| 属性 | 类型 | 验证方式 | 备注 |
|---|---|---|---|
| Name | string | 非空 | 项目名称不能为空 |
| 长度（20） | 项目名称在20个字符之内 | ||
| No | string | 非空 | 项目编号不能为空 |
| 长度（20） | 项目编号在20个字符之内 | ||
| ExpertIds | IList | 非空 | 专家ID不能为空 |