webapi快速开发框架,webapi开发框架有哪些

北大青鸟设计培训：net编程开发测试技术？

对于大多数的程序员来说，只要掌握相关的编程开发技术就可以，而对于软件测试来说基本上都是由测试人员来负责的，但是在一些小型的软件开发公司来说，大部分的开发程序员也是需要兼职测试的，下面java课程培训机构就一起来了解一下，net编程开发的测试技术都有哪些内容。

ASP.NETCoreWebAPI快速入门让我们一起来快速了解一下.NET和ASP.NETCore。

ASP.NETCore是Microsoft创造的全新Web框架，以便摆脱自ASP.NET1.0以来一直存在的遗留技术。

ASP.NETCore2.1摆脱这些遗留依赖，从头开始开发框架，因此可以给开发人员提供更高的性能，并且它是为跨平台执行而构建的。

什么是单元测试?对有些人来说，测试你的软件可能是一个新的概念，但是它很简单。

我们从单元测试开始。

维基百科对于它的严格定义是“是一种软件测试方法，对源代码的独立单元、一组或多组计算机程序模块以及相关的控制数据、使用程序和操作程序都进行测试，以了解它们是否适合使用”。

我比较喜欢的是一个外行的解释，单元测试是保证在你添加了新的功能或进行了缺陷修复之后，你的解决方案中的代码能像预期一样执行。

我们测试了一个简单的代码示例，来保证它符合我们的预期。

WebAPI要单元测试一些什么?我非常支持使用单元测试来为你的客户保证稳定和健壮的API。

但我清楚地知道要如何使用单元测试，知道要测试什么东西。

我相信，你要恰到好处地对解决方案进行单元测试，而不要做多余的测试。

这是什么意思呢?可能我的观点会引发很多评论，但是我不太注重要100%覆盖你的测试。

我是否认为我们需要能覆盖API解决方案重要部分的测试，单独隔开每个区域，保证每个代码段都是正确的?当然!我会这么做，这也是我想要讨论的。

WebAPI系列之快速入门

前言

随着上位机开发技术的广泛应用，很多小伙伴会有上位机与MES等系统进行数据交互的需求，这时候，我们就需要了解WebAPI的相关技术。

什么是WebAPI？

WebAPI是一个简单的构建HTTP服务的新框架，用于对接各种客户端（浏览器，移动设备），在.Net平台上，WebAPI是一个开源的、理想的、构建REST-ful服务的技术。

WebAPI部署在哪里？

WebAPI部署在IIS中，用于给外部应用提供数据。

为什么要使用WebAPI？

WebAPI本质是网络应用程序接口，网络应用可以通过API接口，可以实现存储服务、消息服务、计算服务等能力，利用这些能力可以进行开发出强大功能的web应用。

创建WebAPI

1、打开VS2019，创建一个新项目，项目模板选择ASP.NET Web应用程序（.NET Framework），如下所示：

2、创建完成后，取一个项目名称，然后点击下一步，在下面的页面中，选择模板为Web API，如下所示：

3、创建项目需要一点时间，由于我们选择好了Web API，所以创建好的项目界面自动会添加好Models/Controllers/Views等文件夹，如下所示：

4、在Models文件夹下，创建一个实体类，如下所示：

5、在Controllers文件夹下，右击创建控制器，这里注意要选择Web API 2控制器模板，名称为THMonitorController，继承ApiController，如下所示：

6、在THMonitorController控制器中，创建一个实体集合对象，同时添加两个Get开头的方法，如下所示：

public?class?THMonitorController?:?ApiController

{

THMonitor[]?THMonitors?=?new?THMonitor[]

{

newTHMonitor(){Name="温度1",Value="22.3",Unit="℃",Desc="温度1"},

newTHMonitor(){Name="温度2",Value="22.1",Unit="℃",Desc="温度2"},

newTHMonitor(){Name="温度3",Value="32.3",Unit="℃",Desc="温度3"},

newTHMonitor(){Name="温度4",Value="22.3",Unit="℃",Desc="温度4"},

newTHMonitor(){Name="湿度1",Value="42.3",Unit="%",Desc="湿度1"},

newTHMonitor(){Name="湿度2",Value="42.1",Unit="%",Desc="湿度2"},

newTHMonitor(){Name="湿度3",Value="42.3",Unit="%",Desc="湿度3"},

newTHMonitor(){Name="湿度4",Value="42.3",Unit="%",Desc="湿度4"},

};

public?IEnumerableGetAllTHMonitor()

{

returnTHMonitors;

}

public?THMonitor?GetTHMonitorByName(string?name)

{

THMonitor?contact?=?THMonitors.FirstOrDefault(item?=?item.Name?==?name);

if(contact?==?null)

{

throw?new?HttpResponseException(HttpStatusCode.NotFound);

}

returncontact;

}

7、这样，最简单的一个WebAPI项目就完成了，直接运行即可，运行地址为。

Web API测试

使用Postman接口工具来进行测试。

Postman是一款功能强大的HTTP调试与模拟插件。获取安装包，后台回复 Postman

1、启动Postman之后，在地址栏输入，如果要获取所有的数据，请求方式选择Get，地址栏后面加个api/THMonitor，点击Send，可以看到返回的数据，结果显示为JSON格式。

2、如果想要查询某个数据，可以加个参数，地址栏为温度1，查询结果如下所示：

3、地址栏格式可以参考项目中的WebApiConfig.cs文件：

我是新阁上位机开发的付老师，用我的专业，成就你的梦想！

-END-

RESTful架构中的webapi

通过webAPI在server端开发一个借口，在client端调用此借口的完整过程。

(VS2010版本如果包括MVC4也可以创建webAPI，或者vs2012及以上版本）

运行环境：VS2017

开发语言：c#

一、server端

1.创建webapi项目，打开vs2017-文件-新建-项目。

2.在项目中添加Controllers和Models两个文件夹，分别用于存放控制器类和实体类。

在Controllers文件夹中添加API控制器类。

控制类添加完成后，会自动生成，GET,POST,PUT,DELETE四个方法。

通过地址确定方法：

get方式：地址：端口号/api/控制器名称

post方式：[HttpGet("方法标识名称")]?地址：端口号/api/控制器名称/方法标识名称

添加一个方法，在方法中描述接口需要完成的操作以及返回值。

需要注意事项：

1）传进来参数的数据类型必须与接收的数据类型相同。

二、client端

1.添加控制台应用程序用来测试调用接口是否成功。

2.定义一个方法用来调用接口并返回数据。

3.定义一个restful接口帮助类。

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

WebApi和MVC有什么区别

MVC的主要使用场景在于Web站点的开发，他在后端实现了一套完整的MVC开发框架，能提供方便的页面开发，默认使用Razor视图引擎，提供了后端html构造，用户可以方便地开发出带页面的站点。

而WebAPI主演提供了一套RestfulAPI的开发框架，提供了较为完整的http语义支持，主要用来做开放API，更抽象，更不注重View的生成。

从实现的角度看，虽然他俩捆绑在一起，但是两者处理管线还是不同的。

谁有IOU的安装包！！

Visual Studio 2013 百度云下载地址 链接:pan.baidu/s/1sjFifox密码: ipqe VS2013注册码： BWG7X-J98B3-W34RT-33B3R-JVYW9 ASP.NET MVC4.0+ WebAPI+EasyUI+KnockOutJS快速开发框架 通用权限管理系统 在线演示地址：115.28.135。