WebAPI系列之快速入门

时间:2021-08-05
本文章向大家介绍WebAPI系列之快速入门,主要包括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开头的方法,如下所示:

7、这样,最简单的一个WebAPI项目就完成了,直接运行即可,运行地址为https://localhost:44382/。

Web API测试

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

Postman是一款功能强大的HTTP调试与模拟插件。获取安装包,搜公众号:dotNet工控上位机 后台回复Postman

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

 2、如果想要查询某个数据,可以加个参数,地址栏为https://localhost:44382/api/THMonitor?Name=温度1,查询结果如下所示:

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

原文地址:https://www.cnblogs.com/xiketang/p/15104214.html