使用.NET 6开发TodoList应用(19)——处理OPTION和HEAD请求

系列导航及源代码#

• 使用.NET 6开发TodoList应用文章索引

需求#

在HTTP请求中，我们还剩下两类不常使用的请求没有讲到，本文就来实现以下关于OPTIONS和HEAD请求。OPTIONS请求用来货哦去关于某个特定的URI能够允许执行的请求类型，而HEAD请求可以理解为不实际获取返回结果的GET请求，通常用于校验资源接口、测试资源可达性或者测试资源最近的改动。

目标#

实现OPTIONS和HEAD请求响应。

原理与思路#

在.NET Web API项目中，我们只需要在Controller请求上方加入对应的请求方法，再按要求对应填充Header里的相关字段即可。

实现#

实现OPTIONS请求#

我们在TodoItemController中加入一个新的Action，并使用HttpOptions来标记该Action：

• TodoItemController.cs

// 省略其他...
[HttpOptions]
public Task<ApiResponse<string>> GetTodoItemsOptions()
{
    Response.Headers.Add("Allow", "GET, OPTIONS, POST, PUT");

    return Task.FromResult(ApiResponse<string>.Success(""));
}

实现HEAD请求#

对于HEAD请求，我们直接在GetTodoItemsWithCondition上添加HttpHead即可：

• TodoItemController.cs

// 省略其他...
[HttpHead]
[HttpGet]
public async Task<ApiResponse<PaginatedList<ExpandoObject>>> GetTodoItemsWithCondition([FromQuery] GetTodoItemsWithConditionQuery query)
{
    return ApiResponse<PaginatedList<ExpandoObject>>.Success(await _mediator.Send(query));
}

验证#

验证OPTIONS请求#

启动Api项目，执行OPTIONSTodoItem的请求：

• 请求
  

• 响应
  

验证HEAD请求#

启动Api项目，执行HEADTodoItem的请求：

• 请求
  

• 响应
  

HEAD请求实际已经被执行了，只不过并没有填充响应体数据。

总结#

关于这两种请求，我们在项目中使用的较少，所以只做简单的演示。我会对系列内容进行一些顺序上的调整，关于HATEOAS和Root Document相关的内容放到最后再来介绍，因为实际使用过程中涉及到的很少。下一篇文章我们将介绍关于API版本管理的相关知识。