使用ASP.Net WebAPI构建REST服务

我来为您详细讲解如何使用ASP.Net WebAPI构建REST服务的完整攻略。

ASP.NET WebAPI构建REST服务

什么是REST

REST，指的是“Representational State Transfer”的缩写，即“表现层状态转移”。它是一种非常常见和流行的Web应用程序架构风格。

RESTful架构是建立在HTTP协议之上的，使用HTTP的原生方法（GET、POST、PUT和DELETE）来进行数据传输。它利用这些方法来实现请求资源（通常使用URL）和执行操作（通常是CRUD操作）。

创建WebAPI应用程序

首先，在Visual Studio中，右击解决方案，选择“添加新项目”并选择ASP.NET Web Application。

在新建项目的窗口中，选择“Web API”。

接着，定义“ValuesController”并添加一些草图类。

using System.Collections.Generic;
using System.Web.Http;

namespace WebAPI.Controllers
{
    public class ValuesController : ApiController
    {
        static List<string> strings = new List<string>
        {
            "value1", "value2", "value3"
        };

        // GET api/values
        public IEnumerable<string> Get()
        {
            return strings;
        }

        // GET api/values/5
        public string Get(int id)
        {
            return strings[id];
        }

        // POST api/values
        public void Post([FromBody]string value)
        {
            strings.Add(value);
        }

        // PUT api/values/5
        public void Put(int id, [FromBody]string value)
        {
            strings[id] = value;
        }

        // DELETE api/values/5
        public void Delete(int id)
        {
            strings.RemoveAt(id);
        }
    }
}

测试REST服务

我们可以使用Postman测试我们的REST服务。以下是一些有关测试不同请求（GET、POST、PUT和DELETE）的示例。

• GET请求

使用以下URL获取值数组：

https://localhost:44326/api/values

您将收到以下响应：

[
    "value1",
    "value2",
    "value3"
]

单击“Send”按钮后，您可以在底部的响应中看到响应。

• GET请求

使用以下URL通过id获取值：

https://localhost:44326/api/values/0

您将收到以下响应：

"value1"

• POST请求

使用以下URL创建/添加新值：

https://localhost:44326/api/values

在Body选项卡中，选择“raw”和“JSON（application/json）”，然后键入以下内容：

"value4"

请求是如下所示：

POST /api/values HTTP/1.1
Host: localhost:44326
Content-Type: application/json
cache-control: no-cache
Postman-Token: e7745d3e-fdbe-4fd8-9030-5f69663fc8d7

"value4"

• PUT请求

使用以下URL更新值：

https://localhost:44326/api/values/2

在Body选项卡中，选择“raw”和“JSON（application/json）”，然后键入以下内容：

"value333333"

请求如下所示：

PUT /api/values/2 HTTP/1.1
Host: localhost:44326
Content-Type: application/json
cache-control: no-cache
Postman-Token: ab12d9b3-b45a-4389-9c0d-2326cafc4ae2

"value333333"

• DELETE请求

使用以下URL删除值：

https://localhost:44326/api/values/0

请求如下所示：

DELETE /api/values/0 HTTP/1.1
Host: localhost:44326
Content-Type: application/json
cache-control: no-cache
Postman-Token: b259b534-f3f7-4083-8cf4-6c7226b51946

结论

这就是如何使用ASP.NET WebAPI构建REST服务的完整攻略。在这篇文章中，我们讨论了REST和WebAPI的基础知识，还演示了一些测试不同请求（GET、POST、PUT和DELETE）的代码示例。 REST API已成为最常用的API之一，并且它与大多数开发语言和框架兼容。