文章目录:

• 1、WebAPI系列之快速入门
• 2、如何使用web api测试工具siege和ab的post方法来发送json数据 / 蓝讯
• 3、web测试,怎么查看新增的接口和字段
• 4、有哪些webapi开发好用的工具
• 5、如何使 WebAPI 自动生成漂亮又实用在线API文档
• 6、如何测试webservice和websocket接口

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-

如何使用web api测试工具siege和ab的post方法来发送json数据 / 蓝讯

webapi 支持post get 只需要方法名称是post 和get 就可以了 function nTabs(thisObj,Num){ if(thisObj.className == "active")return; var tabObj = thisObj.parentNode.id; var tabList = document.getElementById(tabObj).getElementsByTagName("li"); for(i=0; i tabList.length; i++) {

web测试,怎么查看新增的接口和字段

1webapi渗透测试工具：配置 接口注释。

（1）配置生成xmlwebapi渗透测试工具的路径。webapi渗透测试工具我们在项目上面点右键→属性→生成标签页配置xml的路径。

（2）在xml的读取路径：在Areas\HelpPage\App_Start\HelpPageConfig.cs里面配置xml的读取路径。

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")));

到此运行webapi渗透测试工具，Api 接口注释已经可以展示。

2：配置接口调试程序。

（1）右键项目webapi渗透测试工具，找到NuGet管理，查找 “WebApiTestClient”并安装。

（2）修改生成的 Areas\HelpPage\Views\Help\Api.cshtml文件。

在结尾处增加一段代码：

@Html.DisplayForModel("TestClientDialogs")@section Scripts {linktype ="text/css" href="~/Areas/HelpPage/HelpPage.css" rel="stylesheet" /@Html.DisplayForModel("TestClientReferences")}

到此，注释和测试工具均已配置完成。运行测试下效果。

OK!

有哪些webapi开发好用的工具

先定义一个简单的webapi，简单到差不多直接用vs2010自动生成的webapi代码。其中的TestModle是一个简单的class，如下public class TestModle { public string a { get; set; } public string b { get; set; } public string c { get; set; } }

如何使 WebAPI 自动生成漂亮又实用在线API文档

1.1 SwaggerUI

SwaggerUI 是一个简单的Restful API 测试和文档工具。简单、漂亮、易用（官方demo）。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. webapi渗透测试工具你可以几乎放在任何Web容器上使用。

1.2 Swashbuckle

Swashbuckle 是.NET类库,可以将WebAPI所有开放的控制器方法生成对应SwaggerUI的JSON配置。再通过SwaggerUI 显示出来。类库中已经包含SwaggerUI 。所以不需要额外安装。

2.快速开始

创建项目 OnlineAPI来封装百度音乐服务(示例下载) webapi渗透测试工具，通过API可以搜索、获取音乐的信息和播放连接。

我尽量删除一些我们demo中不会用到的一些文件，使其看上去比较简洁。

WebAPI 安装 Swashbuckle

Install-Package Swashbuckle

代码注释生成文档说明。

Swashbuckle 是通过生成的XML文件来读取注释的，生成 SwaggerUI，JSON 配置中的说明的。

安装时会在项目目录 App_Start 文件夹下生成一个 SwaggerConfig.cs 配置文件，用于配置 SwaggerUI 相关展示行为的。如图webapi渗透测试工具：

将配置文件大概99行注释去掉并修改为

c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));

并在当前类中添加一个方法

/// summary

/// /summary

/// param name="name"/param

/// returns/returns

protected static string GetXmlCommentsPath(string name)

{

return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name);

}

紧接着你在此Web项目属性生成选卡中勾选 “XML 文档文件”，编译过程中生成类库的注释文件

添加百度音乐 3个API

访问 ;youhost/swagger/ui/index,最终显示效果

我们通过API 测试API 是否成功运行

3.添加自定义HTTP Header

在开发移动端 API时常常需要验证权限，验证参数放在Http请求头中是再好不过webapi渗透测试工具了。WebAPI配合过滤器验证权限即可

首先我们需要创建一个 IOperationFilter 接口的类。IOperationFilter

using System;

using System.Collections.Generic;

using System.Linq;

using System.Web;

using System.Web.Http;

using System.Web.Http.Description;

using System.Web.Http.Filters;

using Swashbuckle.Swagger;

namespace OnlineAPI.Utility

{

public class HttpHeaderFilter : IOperationFilter

{

public void Apply(Operation operation, SchemaRegistry

schemaRegistry, ApiDescription apiDescription)

{

if (operation.parameters == null) operation.parameters = new

ListParameter();

var filterPipeline =

apiDescription.ActionDescriptor.GetFilterPipeline();

//判断是否添加权限过滤器

var isAuthorized = filterPipeline.Select(filterInfo =

filterInfo.Instance).Any(filter = filter is IAuthorizationFilter);

//判断是否允许匿名方法

var allowAnonymous =

apiDescription.ActionDescriptor.GetCustomAttributesAllowAnonymousAttribute().Any();

if (isAuthorized !allowAnonymous)

{

operation.parameters.Add(new Parameter

{

name = "access-key",

@in = "header",

description = "用户访问Key",

required = false,

type = "string"

});

}

}

}

}

在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码

c.OperationFilterHttpHeaderFilter();

添加Web权限过滤器

using System;

using System.Collections.Generic;

using System.Linq;

using System.Net;

using System.Net.Http;

using System.Text;

using System.Web;

using System.Web.Http;

using System.Web.Http.Controllers;

using Newtonsoft.Json;

namespace OnlineAPI.Utility

{

/// summary

///

/// /summary

public class AccessKeyAttribute : AuthorizeAttribute

{

/// summary

/// 权限验证

/// /summary

/// param name="actionContext"/param

/// returns/returns

protected override bool IsAuthorized(HttpActionContext actionContext)

{

var request = actionContext.Request;

if (request.Headers.Contains("access-key"))

{

var accessKey = request.Headers.GetValues("access-key").SingleOrDefault();

//TODO 验证Key

return accessKey == "123456789";

}

return false;

}

/// summary

/// 处理未授权的请求

/// /summary

/// param name="actionContext"/param

protected override void HandleUnauthorizedRequest(HttpActionContext actionContext)

{

var content = JsonConvert.SerializeObject(new {State = HttpStatusCode.Unauthorized});

actionContext.Response = new HttpResponseMessage

{

Content = new StringContent(content, Encoding.UTF8, "application/json"),

StatusCode = HttpStatusCode.Unauthorized

};

}

}

}

在你想要的ApiController 或者是 Action 添加过滤器

[AccessKey]

最终显示效果

4.显示上传文件参数

SwaggerUI 有上传文件的功能和添加自定义HTTP Header 做法类似，只是我们通过特殊的设置来标示API具有上传文件的功能

using System;

using System.Collections.Generic;

using System.Linq;

using System.Web;

using System.Web.Http.Description;

using Swashbuckle.Swagger;

namespace OnlineAPI.Utility

{

/// summary

///

/// /summary

public class UploadFilter : IOperationFilter

{

/// summary

/// 文件上传

/// /summary

/// param name="operation"/param

/// param name="schemaRegistry"/param

/// param name="apiDescription"/param

public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)

{

if (!string.IsNullOrWhiteSpace(operation.summary) operation.summary.Contains("upload"))

{

operation.consumes.Add("application/form-data");

operation.parameters.Add(new Parameter

{

name = "file",

@in = "formData",

required = true,

type = "file"

});

}

}

}

}

在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码

c.OperationFilterUploadFilter();

API 文档展示效果

如何测试webservice和websocket接口

您好：WebSocket是html5新增加的一种通信协议，目前流行的浏览器都支持这个协议，例如Chrome，Safari，Firefox，Opera，IE等等，对该协议支持最早的应该是chrome，从chrome12就已经开始支持，随着协议草案的不断变化，各个浏览器对协议的实现也在不停的更新。该协议还是草案，没有成为标准，不过成为标准应该只是时间问题了，从WebSocket草案的提出到现在已经有十几个版本了，目前最新的是版本17，所对应的协议版本号为13，目前对该协议支持最完善的浏览器应该是chrome，毕竟WebSocket协议草案也是Google发布的。

1. WebSocket API简介

首先看一段简单的javascript代码，该代码调用了WebSockets的API。

[javascript] view plaincopy

var ws = new WebSocket(“ws://echo.websocket.org”);

ws.onopen = function(){ws.send(“Test!”); };

ws.onmessage = function(evt){console.log(evt.data);ws.close();};

ws.onclose = function(evt){console.log(“WebSocketClosed!”);};

ws.onerror = function(evt){console.log(“WebSocketError!”);};

这份代码总共只有5行，现在简单概述一下这5行代码的意义。

第一行代码是在申请一个WebSocket对象，参数是需要连接的服务器端的地址，同http协议使用http://开头一样，WebSocket协议的URL使用ws://开头，另外安全的WebSocket协议使用wss://开头。

第二行到第五行为WebSocket对象注册消息的处理函数，WebSocket对象一共支持四个消息 onopen, onmessage, onclose和onerror，当Browser和WebSocketServer连接成功后，会触发onopen消息；如果连接失败，发送、接收数据失败或者处理数据出现错误，browser会触发onerror消息；当Browser接收到WebSocketServer发送过来的数据时，就会触发onmessage消息，参数evt中包含server传输过来的数据；当Browser接收到WebSocketServer端发送的关闭连接请求时，就会触发onclose消息。我们可以看出所有的操作都是采用消息的方式触发的，这样就不会阻塞UI，使得UI有更快的响应时间，得到更好的用户体验。