系统接口设计案例(系统接口设计案例分析)

网友投稿 366 2022-12-30


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

本文目录一览:

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)--系统级别字典和公司级别字典并存的处理方式

「产品前端架构」接口设计

用户使用 Web 客户端访问 Web 系统,系统在收到请求后执行操作
(收集数据模型,选择数据经行组装),将结果返回给客户。

其中包括的元素和关系如下图所示:

约定

每个规范也会对应若干规定若干规则约定来指导前后端工程师的具体实施。

页面入口规范(范例)

同步数据规范(范例)

异步接口规范(范例)

通过 模拟数据 的形成,将前端本地开发与后端独立出来,
这样前端工程师就可以独立的进行本地的开发工作。

使用页面入口规范制定项目结构(配置信息,目录结构和模板结构),
此过程可以使用自动化工具自动完成。

根据同步数据规范可生成模拟数据的配置文件。(此部分通用可以使用自动化工具来完成)

根据异步接口规范生成模拟异步数据。

前端开发环境包含两个部分, 本地模拟服务器 和 本地代理 。

Local Server

根据请求规则进行匹配,然后生成(整合模板和模拟数据)所请求的页面

Local Proxy

拦截异步请求后,根据请求的匹配规则返回所请求的数据(例如 JSON 或 XML)。

前后端联调需要去除本地环境,在实际开发中只需要对配置文件进行调整既可
(控制哪些请求需要被本地服务器或代理拦截,哪些需要使用远程服务器)。

API是什么,可以应用于哪些地方,有例子吗

API(Application Programming Interface,应用程序接口),一些预先定义的函数,或指软件系统不同组成部分衔接的约定。目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问原码,或理解内部工作机制的细节。

API主要提供通用功能集。API同时也是一种中间件,为各种不同平台提供数据共享。程序设计的实践中,编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖,提高组成单元的内聚性,降低组成单元间的耦合程度,从而提高系统的可维护性和可扩展性。



扩展资料

应用程序接口原理

在数据封装时,网络分层中的每个层相互之间会用接口进行交互并提供服务,其中应用层与用户之间的接口称之为应用程序接口(API,Application Programming Interface)。

API实际上是一种功能集合,也可说是定义、协议的集合,无论是那种集合,它的实质都是通过抽象为用户屏蔽实现上的细节和复杂性。

从用户角度看应用程序接口,表现为一系列API函数,用户可以使用这些函数进行网络应用程序开发。从网络角度看,应用程序接口给用户提供了一组方法,用户可以使用这组方法向应用层发送业务请求、信息和数据,网络中的各层则依次响应,最终完成网络数据传输。

参考资料来源:百度百科-应用程序接口

参考资料来源:百度百科-api

ARM9嵌入式系统设计基础教程的第5章 嵌入式系统输入/输出设备接口

5.1 通用输入/输出接口
5.1.1 通用输入/输出接口原理与结构
5.1.2 S3C2410A输入/输出接口编程实例
5.2 A/D转换器接口
5.2.1 A/D转换系统接口设计案例的方法和原理
5.2.2 S3C2410A系统接口设计案例的A/D转换器
5.2.3 S3C2410A A/D接口编程实例
5.3 D/A转换器接口
5.3.1 D/A转换器系统接口设计案例的工作原理
5.3.2 S3C2410A与D/A转换器系统接口设计案例的接口电路
5.4 键盘与LED数码管接口
5.4.1 键盘与LED数码管接口基本原理与结构
5.4.2 用I/O口实现键盘接口
5.4.3 采用专用芯片实现键盘及LED接口
5.5 LCD显示接口
5.5.1 LCD显示接口原理与结构
5.5.2 S3C2410A的LCD控制器
5.5.3 S3C2410A LCD显示的编程实例
5.6 触摸屏接口
5.6.1 触摸屏工作原理与结构
5.6.2 采用专用芯片的触摸屏控制接口
5.6.3 S3C2410A的触摸屏接口电路
思考题与习题

FPGA有几种形式!

FPGA(现场可编程逻辑器件)以其体积小、功耗低、稳定性高等优点被广泛应用于各类电子产品的设计中。FPGA系统设计的背景知识、硬件电路设计,硬件描述语言Verilog HDL的基本语法和常用语句,FPGA的开发工具软件的使用,基于FPGA的软核嵌入式系统,FPGA设计的基本原则、技巧、IP核, FPGA在接口设计领域的典型应用,FPGA+DSP的系统设计与调试,以及数字变焦系统和PCI数据采集系统这两个完整的系统设计案例。
目前主流的FPGA形式一般有:JTAG、通过外部EEROM配置芯片主动配置(所谓主动是指被配置的FPGA产生配置时序),通过外部处理器或者EEROM配置芯片被动配置(所谓被动就是外部处理器产生配置时序)等。

物流物流管理信息系统案例分析

你是物流交通职业学院哪个班的啊
我也做这道题也!
先给你点资料哈
中铁联合物流信息系统的应用
在运营管理中,中铁联合物流信息系统平台是企业内部业务操作和管理决策的基础,也是企业与客户、合作伙伴和外部资源协同商务的枢纽。
无论是业务应用的多样性、个性化还是基础设施建设规模,中铁联合物流信息系统都是非常复杂庞大的。在充分考虑既要满足当前业务需要,还要适应未来业务发展的基础上,设计出中铁联合物流信息系统总体架构,并以此架构为蓝图,统一规划,分步实施。
整体信息系统的设计采用了目前最先进的企业信息门户技术,在统一的平台上开发和集成企业各种应用系统,避免了信息孤岛现象。所有的应用子系统通过统一的数据库平台进行数据整合,实现信息高度共享、数据挖掘以及提供综合决策支持。系统用户的管理利用LDAP标准实行集中式管理,在大大方便用户使用的同时,加强了系统的内部安全防范。整体系统开发主要基于Java技术,遵循J2EE标准,支持XML,提供多种数据库、WEB服务器接口,适应中铁联合物流的快速业务扩展,系统的稳定性、安全性、扩展性从技术上得到了充分保证。
在应用系统方面,以中铁联合物流六大主营业务系统为主体。其中,在相关子业务系统中,充分考虑了专业物流企业的管理运作需要,高度集成了主流物流技术的应用系统,如条形码、无线射频、GPS/GIS、高架立体仓库、自动分拣等。应用系统还包括企业网站、内联网、办公自动化系统、财务系统、决策支持系统等。
只有这么多了
等找到了再发哈 !!!! 关于系统接口设计案例和系统接口设计案例分析的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站。 系统接口设计案例的介绍就聊到这里吧,感谢你花时间阅读本站内容,更多关于系统接口设计案例分析、系统接口设计案例的信息别忘了在本站进行查找喔。

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

上一篇:系统接口设计报告(系统接口设计案例)
下一篇:Java通过python命令执行DataX任务的实例
相关文章

 发表评论

暂时没有评论,来抢沙发吧~