开发日记:接口开发设计

接口开发使用规则

业务术语：

---

请求：通过HTTP协议把需要传输的数据发送给接收方的过程。

返回：根据得到的数据处理完成后，将处理完成的结果反馈给接收方。

敏感词：带有敏感政治倾向，暴力倾向，不健康色彩或不文明的词。

特殊字符：特殊字符包括：^ | $ # 等。

操作结果：成功失败，成功返回结果，失败返回结果错误信息。

操作流程：执行之前，执行之后，正在执行。

接口编写规则：

---

1. 所有的接口必须包含method和version参数。

2. 所有的接口增加了版本号管理，以便适应多个不同版本客户端的使用。

3. 统一的接口调用方式，减少切换思维导致编码速度下降。

4. 接口返回结果统一使用标准的JSON格式，暂时不考虑使用XML格式。

5. 所有的接口必须要有日志，方便维护。

接口接入规则：

---

1. 配置合作着接入ID必须是唯一的。

2. 所有的接口必须包含method和version参数。

3. 参数列表中，不可空的参数必须配置。

4. 参数列表中，可空的但需要多选一的多个参数中，必须配置至少一个。

5. 字符串转化成字节流时指定的字符集必须与接口一直，常用的字符串编码有：（ASCII/Unicode/UTF-8）。

6. 接口数据传输必须使用http协议，支持get或post方式提交。

7. 保证网络顺畅,防止重复提交。

8. 如果响应时间过长直接导致数据返回失败，提示接收端重新提交。

接口编码设计：

---

使用抽象依赖倒置思维进行接口设计

· 定义一个通用抽象类

public interface IService

{

/// <summary>

/// 调用服务。