C#中的REST API

REST (Representational State Transfer) 是一种基于 HTTP 协议的 Web API 设计风格，它是构建分布式应用和服务的一种方式。C#语言提供了强大的工具集来创建 REST API，本文将向你介绍如何在C#中构建 REST API。

基础知识

在开始构建 REST API 之前，需要了解本文中使用的一些重要术语：

• 资源(Resource)：RESTful API 的核心就是资源，每个资源都可以通过一个唯一的 URI 来标识。
• 请求(Request)：客户端通过 HTTP 请求来获取或修改资源的信息。
• 响应(Response)：服务器通过 HTTP 响应来向客户端返回资源的信息。
• 状态码(Status Code)：HTTP 响应中包含一个状态码，表示服务器对请求的响应状态。

RESTful API 遵循以下规则：

• 使用 HTTP 方法来描述对资源的操作。
• 使用 URI 来标识资源。
• 如有需要，使用查询参数和请求正文来提供附加的数据。
• 使用状态码来表示响应状态。

创建 REST API

使用 C# 创建 REST API 很容易。需要实现以下步骤：

1. 创建 ASP.NET Core Web 应用程序。

dotnet new webapi -n MyApi

2. 在 Controllers 文件夹中创建控制器来处理 API 过程。

using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("api/[controller]")]
public class MyController : ControllerBase
{
    [HttpGet]
    public ActionResult<IEnumerable<string>> Get()
    {
        return new string[] { "Hello", "World" };
    }

    [HttpGet("{id}")]
    public ActionResult<string> Get(int id)
    {
        return "value";
    }

    [HttpPost]
    public void Post([FromBody] string value)
    {
    }

    [HttpPut("{id}")]
    public void Put(int id, [FromBody] string value)
    {
    }

    [HttpDelete("{id}")]
    public void Delete(int id)
    {
    }
}

控制器 MyController 包含五个方法，分别响应 HTTP GET、POST、PUT 和 DELETE 请求。这些方法使用 ASP.NET Core MVC 功能生成 JSON 格式的响应。

3. 启动应用程序。

在命令行中运行以下命令：

dotnet run

4. 测试 API。

API 可以通过 HTTP 请求进行测试，例如：

• GET 方法：http://localhost:5000/api/my
• POST 方法：http://localhost:5000/api/my
• PUT 方法：http://localhost:5000/api/my/1
• DELETE 方法：http://localhost:5000/api/my/1

结论

C# 中的 REST API 是一种灵活且易于使用的方式来构建 Web API。在 ASP.NET Core 中，使用 .NET 5 来构建 REST API 尤为方便。

参考链接：

1. ASP.NET Core Web API 的入门
2. C# 中的 REST API