摘要

ASP.NET Web API 是一种在.NET框架上生成Web API的框架，它提供了一系列的工具和特性，使得开发者能够快速、高效地创建符合 RESTful API 规范的接口，同时还能够支持多种编程语言和技术栈。

Web API 可以应用到广泛的客户端，如浏览器、移动设备和传统的桌面应用程序。它支持多种 HTTP 方法，包括 GET、POST、PUT、DELETE 等，能够轻松地处理不同类型的请求和响应数据。Web API 还提供了丰富的控制器和操作，可以轻松地定义接口和业务逻辑，实现数据的读取、写入和修改等操作。此外，Web API 还支持动态路由和动态参数，使得接口的定义更加灵活和易于扩展。

Web API 的优势在于其跨平台和可扩展性。由于 Web API 可以应用到多种客户端，开发者可以使用不同的技术栈和编程语言来开发应用程序，并且可以轻松地将不同的组件和库进行整合。此外，Web API 还支持多种协议，如 JSON、XML 等，能够满足不同客户端的需求。

随着前后端分离模式的普及，Web API成为未来开发的主流方式。它可以应用于广泛的客户端，包括浏览器、移动设备和传统的桌面应用程序。

JSON是什么？

JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，可使人们很容易地进行阅读和编写，同时也方便了机器进行解析和生成。JSON适用于进行数据交互的场景，如网站前台与后台之间的数据交互。

JSON是比XML更简单的一种数据交换格式，它采用完全独立于编程语言的文本格式来存储和表示数据。
其语法规则如下：

• 使用键值对( key:value )表示对象属性和值。
• 使用逗号(，)分隔多条数据。
• 使用花括号{}包含对象。
• 使用方括号[ ]表示数组。
• 在JavaScript语言中，一切皆是对象，所以任何支持的类型都可以通过JSON来表示，如字符串、数字、对象、数组等。其中，对象和数组是比较特殊且常用的两种类型。

一个例子

新建一个项目

修改项目名，解决方案名

这里可以修改.net 版本，我们一般不做任何修改，OpenAPI一定勾选上。

下一步看到这个界面

看一下Program，这里与MVC中基本一样

点击运行，看到了Swagger界面

这是一个可视化调试界面，只能是开发人员可以看到。

点击Execute后，我们打开浏览器调试界面

能看到在Network中请求过来的JSON数据。这个就是WebAPI返回数据。

WeatherForecastController中

[HttpGet(Name = "GetWeatherForecast")]
public IEnumerable<WeatherForecast> Get()
{
    return Enumerable.Range(1, 5).Select(index => new WeatherForecast
    {
        Date = DateTime.Now.AddDays(index),
        TemperatureC = Random.Shared.Next(-20, 55),
        Summary = Summaries[Random.Shared.Next(Summaries.Length)]
    })
    .ToArray();
}

Model类

我们新创建一个Model，这个模型是一个设备类

public class Equipment
{
        public string Name { get; set; }
        public string Description { get; set; }
        public double Weight { get; set; }
}

Controller API 控制器

创建一个EquipmentController API控制器

这里一定是选API下的Controller

Get方法

代码添加一个GetName方法

[Route("api/[controller]")] //这里的api是一层目录
[ApiController]
public class EquipmentController : ControllerBase
{
    [HttpGet]
    public string GetName()
    {
        return "PLC 1200";
    }
}

发现/api/equipment，就可以读到GetName的返回值，都没有写GetName的方法名，为什么？

Post 方法

增加一个Post方法，用于保存设备信息

[HttpPost]
public bool Save(Equipment equipment)
{
    //do save to db
    return true;
}

这时可以看到一个Post方法出现了，我们可以点击调试。

你会发现，Post输入的值会自动填充到类Save方法的Equipment中。