接口如何设计（接口设计方案）

本篇文章给大家谈谈接口如何设计，以及接口设计方案对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。 今天给各位分享接口如何设计的知识，其中也会对接口设计方案进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、接口用例设计
• 2、接口设计的主要依据是什么.接口设计主要包括哪些内容
• 3、App 和 Web 的通用接口该怎么设计
• 4、如何设计模块接口 模块接口设计技巧

接口用例设计

目的：测试接口的正确性和稳定性接口如何设计；

原理：模拟客户端向服务器发送请求报文，服务器接收请求报文后对相应的报文做处理并向客户端返回应答，客户端接收应答的过程接口如何设计；

重点：检查数据的交换，传递和控制管理过程，还包括处理的次数接口如何设计；

核心：持续集成是接口测试的核心；

优点：为高复杂性的平台带来高效的缺陷监测和质量监督能力，平台越复杂，系统越庞大，接口测试的效果越明显

用例设计重点：通常情况下主要测试最外层的两类接口:数据进入系统接口（调用外部系统的参数为本系统使用）和数据流出系统接口（验证系          统处理后的数据是否正常）；
输入参数主要从以下几各方面设计：

a 必填项校验

接口文档中有是否必填的说明。参考接口文档即可。

b 参数长度校验

参考接口文档即可。

c 参数值的有效性校验

所以参数有效性的校验就需要结合实际业务场景，判断哪些数据是真实有效的数据，一定要确保所有真实有效的数据是可以验证通过的。

d 参数组合校验

不同的参数组合可能会存在不同的业务场景；

e 如果参数是枚举值，一定要各种枚举值都要测试，因为可能不同的枚举走的不同的业务流程；

f 参数值的默认值的校验

参考接口文档。

g 某些参数具有特定的生成规则，要单独针对生成规则设计用例，一定要保证真实有效的数据是可以验证通过的。
接口逻辑我用的设计方法是分支覆盖—路径覆盖—场景覆盖,同样也是要结合实际业务场景，根本不发生的业务场景就是无效的测试用例。

a 第一步先把业务流程图画出来；

b 依据路程图中的分支分别设计，不同分支不同的场景，这里就要把异常的场景考虑进去；如接口超时，接口异常，接口请求成功或失败，成功后怎么处理，失败后流程是否继续执行，失败后的数据怎么处理；

c 测试逻辑设计完成后要想一想不同的业务场景怎么去测试，需要哪些人员协助，

如接口超时怎么去测试，请求重复怎么去测试，请求并发怎么去测试
输入结果：正常输出和异常输出，常用的方法有错误推断法（列举出程序中可能存在的错误或者异常，根据接口如何设计他们选择测试用例）

接口设计的主要依据是什么.接口设计主要包括哪些内容

接口设计的主要依据是形象；因为在平面设计中，一组相同或相似的形象组成，其每一组成单位成为基本形，基本形是一个最小的单位，利用它根据一定的构成原则排列、组合、便可得到最好的构成效果。

接口设计主要包括：

1．形状的渐变：一个基本形渐变到另一个基本形，基本形可以由完整的渐变到残缺，也可以由简单到复杂，由抽象渐变到具象；

2．方向的渐变：基本形可在平面上作有方向的渐变；

3．位置的渐变：基本形作位置渐变时需用骨架，因为基本形在作位置渐变时，超出骨架的部分会被切掉；

4．大小的渐变：基本形由大到小的渐变排列，会产生远近深度及空间感；

5．色彩的渐变：在色彩中，色相、明度、纯度都可以出渐变效果，并会产生有层次感的美感；

6．骨格的渐变：是指骨格有规律的变化，使基本形在形状、大小、方向上进行变化。划分骨格的线可以做水平、垂直、斜线、折线、曲线等个总骨格的渐变。渐变的骨格精心排列，会产生特殊的视觉效果，有时还会产生错视和运动感。

扩展资料：

接口设计随着现代科技的发展、知识社会的到来、创新形态的嬗变，设计也正由专业设计师的工作向更广泛的用户参与演变，以用户为中心的、用户参与的创新设计日益受到关注，用户参与的创新2.0模式正在逐步显现。

用户需求、用户参与、以用户为中心被认为是新条件下设计创新的重要特征，用户成为创新2.0的关键词，用户体验也被认为是知识社会环境下创新2.0模式的核心。

设计不再是专业设计师的专利，以用户参与、以用户为中心也成为了设计的关键词，Fab Lab、Living Lab等的创新设计模式的探索正在成为设计的创新2.0模式。

App 和 Web 的通用接口该怎么设计

1、在接口定义中确定MVC的GET或者POST方式
由于我们整个Web API平台是基于MVC的基础上进行的API开发接口如何设计，因此整个Web API的接口接口如何设计，在定义的时候，一般需要显示来声明接口是[HttpGet]或者[HttpPost]，虽然有些接口也可以不用声明，但是避免出现类似下面的错误信息，显式声明还是有好处的。
请求的资源不支持 http 方法“POST
例如在基类定义的查找对象接口如下所示。
/// <summary
/// 查询数据库,检查是否存在指定ID的对象
/// </summary
/// <param name="id"对象的ID值</param
/// <returns存在则返回指定的对象,否则返回Null</returns
[HttpGet]
public virtual T FindByID(string id, string token)
如果是增删改的接口，一般需要声明为POST方式提交数据，而且基于安全性的考虑，需要携带更多的参数。
/// <summary
/// 插入指定对象到数据库中
/// </summary
/// <param name="info"指定的对象</param
/// <returns执行操作是否成功。</returns
[HttpPost]
public virtual CommonResult Insert(T info, string token, string signature, string timestamp, string nonce, string appid)
2、动态对象的接口定义
在一般的Web API接口里面，我们可能都会碰到很多简单类型的参数，但是又想让它们以POST方式提交数据，那么我们就可以有两种方法来处理，一种是定义一个类来放置这些参数，一种是采用动态的JObject参数，前者有很多不方便的地方，因为我们不可能为每个接口参数定义多一个实体类，这样可能会有很多难以管理的类定义。如下面是微信API的调用接口案例，我们也需要设置这样的处理规则。
接口调用请求说明
http请求方式: POST（请使用https协议）
https://api.weixin.qq.com/cgi-bin/groups/update?access_token=ACCESS_TOKEN
POST数据格式接口如何设计：json
POST数据例子：{"group":{"id":108,"name":"test2_modify2"}}
那么我们采用JObject是这么样的呢，我们来看接口的定义和处理代码。JObject是Newtonsoft.Json.Linq命名空间下的一个对象。
/// <summary
/// 修改用户密码
/// </summary
/// <param name="param"包含userName和userPassword的复合对象</param
/// <param name="token"用户访问令牌</param
/// <returns</returns
[HttpPost]
public CommonResult ModifyPassword(JObject param, string token)
{
//令牌检查,不通过则抛出异常
CheckResult checkResult = CheckToken(token);
dynamic obj = param;
if (obj != null)
{
string userName = obj.userName;
string userPassword = obj.userPassword;
bool success = BLLFactory<User.Instance.ModifyPassword(userName, userPassword);
return new CommonResult(success);
}
else
{
throw new MyApiException("传递参数出现错误");
}
}
其中我们把JObject对象转换为我们所需要的对象的时候，因为我们没有定义具体的实体类，因此采用接口如何设计了dynamic语法，声明这是一个动态对象，由运行时获取对应的属性。
dynamic obj = param;
这样我们就可以在调用的时候，动态POST对应的JSON对象给Web API接口，而不需要预先定义各种接口参数的类接口如何设计了。
/// <summary
/// 调用Web API接口，修改用户密码
/// </summary
/// <param name="userName"用户名称</param
/// <param name="userPassword"修改的密码</param
/// <returns如果修改成功返回true，否则返回false</returns
public bool ModifyPassword(string userName, string userPassword)
{
var action = "ModifyPassword";
var postData = new
{
userName = userName,
userPassword = userPassword
}.ToJson();
string url = GetTokenUrl(action);
CommonResult result = JsonHelper<CommonResult.ConvertJson(url, postData);
return (result != null) ? result.Success : false;
}
其中GetTokenUrl是根据token和API的地址等参数，构建一个完整的提交地址。我们在上面代码通过
var postData = new
{
userName = userName,
userPassword = userPassword
}.ToJson();
就可以动态创建一个对象，并生成它的JSON字符串，把数据POST提交到对应的API接口里面即可，然后对结果进行对象的转换就算完成了。
3、集合和分页的处理
在很多接口里面，我们都需要用到分页的处理，Web API也不例外，这样可以提交数据检索效率，减少服务器数据处理的压力，同时也提交客户端的数据显示速度。
一般的集合接口定义如下所示（通用性基类接口）。
/// <summary
/// 返回数据库所有的对象集合
/// </summary
/// <returns指定对象的集合</returns
[HttpGet]
public virtual List<T GetAll(string token)
{
//检查用户是否有权限，否则抛出MyDenyAccessException异常
base.CheckAuthorized(AuthorizeKey.ListKey, token);
List<T list = baseBLL.GetAll();
return list;
}
但是这样的返回记录会比较多，一般情况下需要分页，那么分页的处理接口定义如下所示。
/// <summary
/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
/// </summary
/// <returns指定对象的集合</returns
[HttpPost]
public virtual PagedList<T FindWithPager(string condition, PagerInfo pagerInfo, string token)
分页接口，在这里返回的结果里面，用了一个PageList的泛型类，这个方便我们获取当前的记录及总数，它的定义如下所示。
/// <summary
/// 分页集合
/// </summary
/// <typeparam name="T"对象</typeparam
public class PagedList<T
{
/// <summary
/// 返回记录的总数
/// </summary
public int total_count { get; set; }
/// <summary
/// 列表集合
/// </summary
public List<T list { get; set; }
}
最后整个分页的处理Web API接口实现如下所示。
/// <summary
/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
/// </summary
/// <returns指定对象的集合</returns
[HttpPost]
public virtual PagedList<T FindWithPager(string condition, PagerInfo pagerInfo, string token)
{
//检查用户是否有权限，否则抛出MyDenyAccessException异常
base.CheckAuthorized(AuthorizeKey.ListKey, token);
List<T list = baseBLL.FindWithPager(condition, pagerInfo);
//构造成Json的格式传递
var result = new PagedList<T() { total_count = pagerInfo.RecordCount, list = list };
return result;
}
最后客户端调用分页的Web API代码如下所示。
/// <summary
/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
/// </summary
/// <param name="condition"查询的条件</param
/// <param name="pagerInfo"分页实体</param
/// <returns指定对象的集合</returns
public virtual List<T FindWithPager(string condition, ref PagerInfo pagerInfo)
{
var action = "FindWithPager";
string url = GetTokenUrl(action) + string.Format("condition={0}", condition);
var postData = pagerInfo.ToJson();
List<T result = new List<T();
PagedList<T list = JsonHelper<PagedList<T.ConvertJson(url, postData);
if (list != null)
{
pagerInfo.RecordCount = list.total_count;//修改总记录数
result = list.list;
}
return result;
}
4、混合框架界面整合Web API接口
在整个Web API的平台构建以及在混合框架的整合过程中，我把各个模块还是遵循相对独立的方式进行开发和整合，它们实现了从直接访问数据库、以WCF服务获取数据，以及通过WebAPI调用方式获取数据几种方式的统一，从而实现了整个混合框架的高度整合。
整个混合框架的核心是以相对独立的方式，整合各个可重用的模块，我们可以遵循一定的基础上，快速构建统一的应用平台。
搭建完毕的整个WebAPI平台，其中包括了服务端内容，以API控制器的方式，发布了对应的Web API接口。
在每个混合框架的独立模块里面，我们封装了对应的Web API客户端调用处理，从而实现了Web API的调用方式。
在Win10下，使用Web API模式运行混合框架，获得的主体界面效果如下所示。
独立模块权限管理系统界面如下所示。
系列文章如下所示：
Web API应用架构在Winform混合框架中的应用（1）
Web API应用架构在Winform混合框架中的应用（2）--自定义异常结果的处理
Web API接口设计经验总结
Web API应用架构在Winform混合框架中的应用（3）--Winfrom界面调用WebAPI的过程分解
Web API应用架构在Winform混合框架中的应用（4）--利用代码生成工具快速开发整套应用
Web API应用架构在Winform混合框架中的应用（5）--系统级别字典和公司级别字典并存的处理方式

如何设计模块接口 模块接口设计技巧

每一个大的系统都是有许多模块系统组成的，系统的开发是一个很大的工程，开发起来得难度也是比较大。因此任何一个有一定规模系统，通常会把系统做一定分解降低分析设计开发的难度，模块划分是一个比较常见的方式，而模块与模块之间则是通过接口设计将它们整合在一起的。 实践中，极有可能出现两种状况：接口维护失控或者过严而死板（而影响开发）。接口失控是因为接口的维护太过随意，因为A模块的需要就轻易在B模块中添加一个接口（方法），导致该接口（方法）非独立性（基本上只给模块A的这个功能点使用），或者是接口的控制过严，导致或者工作效率不高，或者接口的易用性不好。 原因在于：接口是两个模块间的耦合，而发生的种种问题在于模块耦合太过紧密；同时实践中，把模块对外提供的接口，与模块需要实现的外部模块的接口混为一谈。 根据指导原则：为了降低耦合只有在中间加一层。一种可行的实践是：不轻易为模块设计对外提供的接口（方法），除非是通过重构得来的；模块对外提供两种类：一个是需要外部模块实现的接口（接口设计从本模块需要出发，当然每个接口尽管是为某个功能点服务，但也要注意其在模块内通用性），另一个是其它模块要求本模块实现的接口的实现类。 即：A模块拥有一些需要B模块实现的接口（A模块对B模块的要求），而B模块中也有要求A模块实现的接口，因而A有这些接口的实现类。 这种实践方式的好处在于：模块的接口就多了一层隔离降低了耦合，把接口的通用性和接口的适应性分离，又明确了模块的边界，使得接口在日后的优化和调整有了缓冲。接口设计的关键是能够将系统的每一个模块能够很好的整合在一起，而且能够让系统能够更好的运行。模块接口设计也是实现系统功能实现整体化的手段，而且是有益于系统拆分、整合等手段所必备的。 关于接口如何设计和接口设计方案的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 接口如何设计的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于接口设计方案、接口如何设计的信息别忘了在本站进行查找喔。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。