在线接口设计-如何正确合理的设计一个接口项目
App和Web的通用接口该怎么设计
1、在接口定义中确定MVC的GET或者POST方式
由于我们整个WebAPI平台是基于MVC的基础上进行的API开发,因此整个WebAPI的接口,在定义的时候,一般需要显示来声明接口是[HttpGet]或者[HttpPost],虽然有些接口也可以不用声明,但是避免出现类似下面的错误信息,显式声明还是有好处的。
请求的资源不支持http方法“POST
例如在基类定义的查找对象接口如下所示。
///<summary>
///查询数据库,检查是否存在指定ID的对象
///</summary>
///<paramname="id">对象的ID值</param>
///<returns>存在则返回指定的对象,否则返回Null</returns>
[HttpGet]
publicvirtualTFindByID(stringid,stringtoken)
如果是增删改的接口,一般需要声明为POST方式提交数据,而且基于安全性的考虑,需要携带更多的参数。
///<summary>
///插入指定对象到数据库中
///</summary>
///<paramname="info">指定的对象</param>
///<returns>执行操作是否成功。</returns>
[HttpPost]
publicvirtualCommonResultInsert(Tinfo,stringtoken,stringsignature,stringtimestamp,stringnonce,stringappid)
2、动态对象的接口定义
在一般的WebAPI接口里面,我们可能都会碰到很多简单类型的参数,但是又想让它们以POST方式提交数据,那么我们就可以有两种方法来处理,一种是定义一个类来放置这些参数,一种是采用动态的JObject参数,前者有很多不方便的地方,因为我们不可能为每个接口参数定义多一个实体类,这样可能会有很多难以管理的类定义。如下面是微信API的调用接口案例,我们也需要设置这样的处理规则。
接口调用请求说明
http请求方式:POST(请使用https协议)
POST数据格式:json
POST数据例子:{"group":{"id":108,"name":"test2_modify2"}}
那么我们采用JObject是这么样的呢,我们来看接口的定义和处理代码。JObject是命名空间下的一个对象。
///<summary>
///修改用户密码
///</summary>
///<paramname="param">包含userName和userPassword的复合对象</param>
///<paramname="token">用户访问令牌</param>
///<returns></returns>
[HttpPost]
publicCommonResultModifyPassword(JObjectparam,stringtoken)
{
//令牌检查,不通过则抛出异常
CheckResultcheckResult=CheckToken(token);
dynamicobj=param;
if(obj!=null)
{
stringuserName=;
stringuserPassword=;
boolsuccess=BLLFactory<User>.(userName,userPassword);
returnnewCommonResult(success);
}
else
{
thrownewMyApiException("传递参数出现错误");
}
}
其中我们把JObject对象转换为我们所需要的对象的时候,因为我们没有定义具体的实体类,因此采用了dynamic语法,声明这是一个动态对象,由运行时获取对应的属性。
dynamicobj=param;
这样我们就可以在调用的时候,动态POST对应的JSON对象给WebAPI接口,而不需要预先定义各种接口参数的类了。
///<summary>
///调用WebAPI接口,修改用户密码
///</summary>
///<paramname="userName">用户名称</param>
///<paramname="userPassword">修改的密码</param>
///<returns>如果修改成功返回true,否则返回false</returns>
publicboolModifyPassword(stringuserName,stringuserPassword)
{
varaction="ModifyPassword";
varpostData=new
{
userName=userName,
userPassword=userPassword
}.ToJson();
stringurl=GetTokenUrl(action);
CommonResultresult=JsonHelper<CommonResult>.ConvertJson(url,postData);
return(result!=null)?:false;
}
其中GetTokenUrl是根据token和API的地址等参数,构建一个完整的提交地址。我们在上面代码通过
varpostData=new
{
userName=userName,
userPassword=userPassword
}.ToJson();
就可以动态创建一个对象,并生成它的JSON字符串,把数据POST提交到对应的API接口里面即可,然后对结果进行对象的转换就算完成了。
3、集合和分页的处理
在很多接口里面,我们都需要用到分页的处理,WebAPI也不例外,这样可以提交数据检索效率,减少服务器数据处理的压力,同时也提交客户端的数据显示速度。
一般的集合接口定义如下所示(通用性基类接口)。
///<summary>
///返回数据库所有的对象集合
///</summary>
///<returns>指定对象的集合</returns>
[HttpGet]
publicvirtualList<T>GetAll(stringtoken)
{
//检查用户是否有权限,否则抛出MyDenyAccessException异常
(,token);
List<T>list=();
returnlist;
}
但是这样的返回记录会比较多,一般情况下需要分页,那么分页的处理接口定义如下所示。
///<summary>
///根据条件查询数据库,并返回对象集合(用于分页数据显示)
///</summary>
///<returns>指定对象的集合</returns>
[HttpPost]
publicvirtualPagedList<T>FindWithPager(stringcondition,PagerInfopagerInfo,stringtoken)
分页接口,在这里返回的结果里面,用了一个PageList的泛型类,这个方便我们获取当前的记录及总数,它的定义如下所示。
///<summary>
///分页集合
///</summary>
///<typeparamname="T">对象</typeparam>
publicclassPagedList<T>
{
///<summary>
///返回记录的总数
///</summary>
publicinttotal_count{get;set;}
///<summary>
///列表集合
///</summary>
publicList<T>list{get;set;}
}
最后整个分页的处理WebAPI接口实现如下所示。
///<summary>
///根据条件查询数据库,并返回对象集合(用于分页数据显示)
///</summary>
///<returns>指定对象的集合</returns>
[HttpPost]
publicvirtualPagedList<T>FindWithPager(stringcondition,PagerInfopagerInfo,stringtoken)
{
//检查用户是否有权限,否则抛出MyDenyAccessException异常
(,token);
List<T>list=(condition,pagerInfo);
//构造成Json的格式传递
varresult=newPagedList<T>(){total_count=,list=list};
returnresult;
}
最后客户端调用分页的WebAPI代码如下所示。
///<summary>
///根据条件查询数据库,并返回对象集合(用于分页数据显示)
///</summary>
///<paramname="condition">查询的条件</param>
///<paramname="pagerInfo">分页实体</param>
///<returns>指定对象的集合</returns>
publicvirtualList<T>FindWithPager(stringcondition,refPagerInfopagerInfo)
{
varaction="FindWithPager";
stringurl=GetTokenUrl(action)+("&condition={0}",condition);
varpostData=();
List<T>result=newList<T>();
PagedList<T>list=JsonHelper<PagedList<T>>.ConvertJson(url,postData);
if(list!=null)
{
=_count;//修改总记录数
result=;
}
returnresult;
}
4、混合框架界面整合WebAPI接口
在整个WebAPI的平台构建以及在混合框架的整合过程中,我把各个模块还是遵循相对独立的方式进行开发和整合,它们实现了从直接访问数据库、以WCF服务获取数据,以及通过WebAPI调用方式获取数据几种方式的统一,从而实现了整个混合框架的高度整合。
整个混合框架的核心是以相对独立的方式,整合各个可重用的模块,我们可以遵循一定的基础上,快速构建统一的应用平台。
搭建完毕的整个WebAPI平台,其中包括了服务端内容,以API控制器的方式,发布了对应的WebAPI接口。
在每个混合框架的独立模块里面,我们封装了对应的WebAPI客户端调用处理,从而实现了WebAPI的调用方式。
在Win10下,使用WebAPI模式运行混合框架,获得的主体界面效果如下所示。
独立模块权限管理系统界面如下所示。
系列文章如下所示:
WebAPI应用架构在Winform混合框架中的应用(1)
WebAPI应用架构在Winform混合框架中的应用(2)--自定义异常结果的处理
WebAPI接口设计经验总结
WebAPI应用架构在Winform混合框架中的应用(3)--Winfrom界面调用WebAPI的过程分解
WebAPI应用架构在Winform混合框架中的应用(4)--利用代码生成工具快速开发整套应用
WebAPI应用架构在Winform混合框架中的应用(5)--系统级别字典和公司级别字典并存的处理方式
如何设计API接口，请求接口时需要进行身份验证，防止第三方随意调用接口？接口使用方法:
1.接口调用者先申请分配一个clientid,clientsecret,并提供给接口提供者(服务器)一个可访问的callbackURL(用于接口access_token)。
2.接口调用者使用clientid,clientsecret作为参数,向接口提供者发送请求。
接口提供者访问callbackURL发送access_token(有时间限制,超时后重新获取)。
3.接口调用者使用access_token作为参数,调用其他接口获取相关信息。
4.接口调用者在access_token超时后重新获取access_token。
有个疑问:
仅为了防止非法用户随意使用接口,需要这个复杂的机制吗?
接口使用https连接,可以确保数据保密性。
所以是否可以简化上面的流程,仅在接口服务者中配置一个access_token,
接口使用者只需要提供正确的access_token即可正常使用其他接口。
如何正确合理的设计一个接口项目了解原型,其实更多是为了帮助你设计接口时需要提供的数据和结构。但有时当你设计时并没有原型,所以此条并不是必须要求的。但假如设计完接口后原型出来了,我们也可以拿原型还验证接口设计是否正确、合理。