接口管理设计（接口管理设计方案）

本文目录一览：

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

• 2、怎么写 App 接口设计方案

• 3、电子酒店门锁管理系统软件接口要怎么设置呢？

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协议）

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 = BLLFactoryUser.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 = JsonHelperCommonResult.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 ListT GetAll(string token)

{

//检查用户是否有权限，否则抛出MyDenyAccessException异常

base.CheckAuthorized(AuthorizeKey.ListKey, token);

ListT list = baseBLL.GetAll();

return list;

}

但是这样的返回记录会比较多，一般情况下需要分页，那么分页的处理接口定义如下所示。

/// summary

/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)

/// /summary

/// returns指定对象的集合/returns

[HttpPost]

public virtual PagedListT FindWithPager(string condition, PagerInfo pagerInfo, string token)

分页接口，在这里返回的结果里面，用了一个PageList的泛型类，这个方便我们获取当前的记录及总数，它的定义如下所示。

/// summary

/// 分页集合

/// /summary

/// typeparam name="T"对象/typeparam

public class PagedListT

{

/// summary

/// 返回记录的总数

/// /summary

public int total_count { get; set; }

/// summary

/// 列表集合

/// /summary

public ListT list { get; set; }

}

最后整个分页的处理Web API接口实现如下所示。

/// summary

/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)

/// /summary

/// returns指定对象的集合/returns

[HttpPost]

public virtual PagedListT FindWithPager(string condition, PagerInfo pagerInfo, string token)

{

//检查用户是否有权限，否则抛出MyDenyAccessException异常

base.CheckAuthorized(AuthorizeKey.ListKey, token);

ListT list = baseBLL.FindWithPager(condition, pagerInfo);

//构造成Json的格式传递

var result = new PagedListT() { total_count = pagerInfo.RecordCount, list = list };

return result;

}

最后客户端调用分页的Web API代码如下所示。

/// summary

/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)

/// /summary

/// param name="condition"查询的条件/param

/// param name="pagerInfo"分页实体/param

/// returns指定对象的集合/returns

public virtual ListT FindWithPager(string condition, ref PagerInfo pagerInfo)

{

var action = "FindWithPager";

string url = GetTokenUrl(action) + string.Format("condition={0}", condition);

var postData = pagerInfo.ToJson();

ListT result = new ListT();

PagedListT list = JsonHelperPagedListT.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）--系统级别字典和公司级别字典并存的处理方式

怎么写 App 接口设计方案

编写接口设计方案头部必定是目录，要是在目录和正文中间插入本方案总设计师姓名和他的手机邮件等联系方式方便双方项目上对接自是极好的

一阐述面向的用户群和平台有哪些；

二要达到怎样的设计目标，如并发量，延迟等；

三设计的系统接口可能会有哪些问题和风险，基于以上，在进行设计过程中将会采用那些技术手段；

四是阐述一些接口命名规范，字段和数据长度限制规范，最大连接时间等；

在后面概述接口按业务或非业务分为哪几大块，订单一块，账户管理一块，日志一块，文件/图片一块；

接下来详述每块分别有哪些接口，具体如何定义的等等；

最后在阐述下整个系统与哪些第三方会有交集，这些接口提供方的公司名字？与这些公司的技术联系人是谁，联系方式是什么，与他们的数据通信方式是什么，他们的访问地址在何处，经过一系列测试后发现的延迟情况，安全问题等等，我方是如何解决的，在本次设计的接口中有哪些用到了这个第三方接口；

电子酒店门锁管理系统软件接口要怎么设置呢？

引言：在当今社会越来越多的人，注重门锁的安全性能是否得高，因为如果需要确保自己资金的安全。像门锁管理也需要达到国家的标准，避免非法分子能够进入家中进行偷盗。那么对于酒店的前景也是非常好的，酒店的行业发展越来越趋近于现代化。所以这个时候就需要注重自己的装修是否能够达到安全性能高的，所以这样的情况下，才能够给自己的生活有一定的保障。不会留下安全隐患，危害以后的生活。那么电池酒店门锁管理系统软件接口要怎么设计呢？在这里，小编有以下几点建议，希望能够帮助大家解决问题。

需要分析材料

不同的材料，它的性能往往是大不相同的，选择好的材料能够有利于他的使用寿命，进一步加强。同时也能够保证它在配合安装时能够发挥它的作用，在管理系统能力上也能够更加的强，所以在电子酒店门锁管理系统软件的接口需要合理的设计。分析材料的性能，找寻正确的方法来进一步安装。总的来说，要想安装管家的接口需要分析材料的。

咨询技术人员

如果在电子酒店门锁管理系统软件接口想要设计一个良好的方案，这个时候就需要咨询相关的技术，能源来为进一步解答。如果给出合理化建议，帮助提高门锁管理系统的安全形容这样就有有利于酒店的持续发展。同时也能够吸引更多的人来住进酒店，这会给酒店带来巨大的经济收益。所以可以咨询相关的技术人员，进一步确立。

询问父母

父母也能够在这方面给予孩子一些常识，毕竟在社会上磨炼了许多年，所以有许多合理化建议，可以给孩子进行沟通和交流。如果在电子酒店门锁管理系统软件接口方面上有疑惑，可以咨询父母。

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