使用ASP.NET Web API构建Restful API

使用ASP.NET Web API构建Restful API的完整攻略包括以下步骤：

步骤1：创建ASP.NET Web API项目

首先，我们需要在Visual Studio中创建一个新的ASP.NET Web API项目。在Visual Studio打开后，选择"File" -> "New" -> "Project"，在弹出的对话框中选择"ASP.NET Web Application"。

在弹出的创建新项目对话框中，选择"Web API"模板，然后单击“创建”按钮。此时Visual Studio会为我们创建一个名为“WebApplication1”的新项目，其中包含了一些默认的文件和代码。

步骤2：添加控制器

接下来，我们需要添加一个控制器来处理HTTP请求，并返回数据或执行特定的操作。在ASP.NET Web API中，控制器扮演着相当关键的角色，用于实现我们自己定义的API。

在Visual Studio中，右键单击我们刚刚创建的项目并选择"添加" -> "新建项"-> "Web API控制器类"。在弹出的对话框中，我们可以输入控制器的名称，例如"ValuesController"，然后单击"添加"按钮。此时我们就会得到一个名为"ValuesController.cs"的文件，其中包含了一些示例代码。

步骤3：设置路由

控制器中定义了一组方法，以处理不同类型的HTTP请求。这些方法可以通过路由来访问。我们需要在ASP.NET Web API中设置路由来将请求映射到我们的控制器方法。

在控制器类中，可以使用"[Route]"属性或"[HttpGet]"等HTTP谓词属性来指定与方法相关联的路由。例如，在"ValuesController.cs"文件中，我们可以使用以下代码：

[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
    // GET api/values
    [HttpGet]
    public ActionResult<IEnumerable<string>> Get()
    {
        return new string[] { "value1", "value2" };
    }

    // GET api/values/5
    [HttpGet("{id}")]
    public ActionResult<string> Get(int id)
    {
        return "value";
    }
}

这段代码指定了我们在"api/values"路径上处理"GET"请求，返回值是包含两个字符串值的数组。同时，我们在"api/values/{id}"路径上处理"GET"请求，返回值是一个字符串值。

步骤4：编写API方法

控制器中定义了多个方法，每个方法都会处理Http请求并返回数据或执行操作。在编写API方法时，您需要使用到“ActionResult”类或其泛型版本，如“ActionResult”类。此时，您可以使用多种方法返回数据，包括：

直接返回数据

public ActionResult<IEnumerable<string>> Get()
{
    return new string[] { "value1", "value2" };
}

使用模型绑定器

public ActionResult<string> Post([FromBody] string value)
{
    return value;
}

返回错误

public ActionResult Get(int id)
{
    if (id < 0)
    {
        return BadRequest("Invalid parameter id");
    }

    // do something else

    return Ok("Success");
}

步骤5：测试API

一旦我们编写了API方法，就可以使用HTTP客户端工具进行测试。可以使用类似Postman或Fiddler的工具向我们的API发送请求并检查响应。

例如，我们可以向我们的API发送HTTP GET请求"api/values"，这将返回一个带有两个值的字符串数组。

类似地，我们可以向"api/values/5"发送HTTP GET请求，这将返回一个包含字符串"value"的ActionResult对象。

示例1: 创建新的学生资源

现在，我们来看一下如何创建一个新的学生资源。我们需要添加一个新的控制器方法，该方法处理"POST"请求，并使用模型绑定器来获取数据。

[Route("api/[controller]")]
[ApiController]
public class StudentsController : ControllerBase
{
    private readonly List<Student> _students;

    public StudentsController()
    {
        _students = new List<Student>()
        {
            new Student { Id = 1, Name = "Tom" },
            new Student { Id = 2, Name = "Jerry" }
        };
    }

    // GET api/students
    [HttpGet]
    public ActionResult<IEnumerable<Student>> Get()
    {
        return _students;
    }

    // GET api/students/5
    [HttpGet("{id}")]
    public ActionResult<Student> Get(int id)
    {
        var student = _students.FirstOrDefault(s => s.Id == id);
        if (student == null)
        {
            return NotFound();
        }

        return student;
    }

    // POST api/students
    [HttpPost]
    public ActionResult<Student> Create([FromBody] Student newStudent)
    {
        if (newStudent == null)
        {
            return BadRequest("Invalid student data");
        }

        var existingStudent = _students.FirstOrDefault(s => s.Id == newStudent.Id);
        if (existingStudent != null)
        {
            return BadRequest("Student already exists");
        }

        _students.Add(newStudent);
        return Ok(newStudent);
    }
}

在这个方法中，我们从请求正文中获取数据，并检查我们是否已经有相同ID的现有学生。如果学生不存在，则我们将其添加到学生列表中。

要测试这个API，我们可以使用Postman发送一个"POST"请求，该请求将包含新增学生的数据。例如，以下JSON可以用作POST请求的正文：

{
    "id": 3,
    "name": "Lucy"
}

我们可以检查响应是否为"200 OK"，并查询我们的学生列表，以查看新的学生是否已成功添加。

示例2: 跟新已有学生

接下来，我们看一下如何更新现有的学生。我们需要修改"PUT"方法，并使用模型绑定器来从请求正文中获取更新后的数据。此外，我们还需要将学生ID作为URL参数传递。

[HttpPut("{id}")]
public ActionResult<Student> Update(int id, [FromBody] Student updatedStudent)
{
    var existingStudent = _students.FirstOrDefault(s => s.Id == id);
    if (existingStudent == null)
    {
        return NotFound();
    }

    existingStudent.Name = updatedStudent.Name;
    return Ok(existingStudent);
}

在这个方法中，我们首先查询具有指定ID的现有学生。如果找到了学生，则将其名称设置为请求正文中的新值，并将其返回。

要测试这个API，我们可以使用Postman发送一个"PUT"请求，该请求将包含与学生相关的数据。例如，以下JSON可以用作PUT请求的正文：

{
    "id": 1,
    "name": "Tom Jerry"
}

我们可以检查响应是否为"200 OK"，并查询我们的学生列表，以查看是否成功更新了学生的名称。

这些就是构建ASP.NET Web API的Restful API的完整攻略。通过遵循这些步骤，您可以轻松地创建和测试自己的Restful API。