ASP.NET Core Web API 在.NET 10 Preview 1中的新特性解析

ASP.NET Core团队在.NET 10 Preview 1版本中为Web API应用引入了多项重要功能增强，这些改进将显著提升开发者的API开发体验。本文将深入解析这些新特性，帮助开发者更好地理解和使用它们。

OpenAPI 3.1支持

.NET 10 Preview 1现在原生支持OpenAPI 3.1规范，这是对之前仅支持OpenAPI 2.0和3.0版本的重要升级。OpenAPI 3.1规范带来了多项改进：

• 完全兼容JSON Schema 2020-12
• 改进了Webhook支持
• 增强了组件复用能力
• 更好的异步API描述支持

开发者现在可以通过简单的配置启用这一功能，无需额外安装第三方库。这一升级使得ASP.NET Core生成的API文档能够更好地与现代API工具链集成。

YAML格式的OpenAPI输出

除了传统的JSON格式外，现在ASP.NET Core Web API还支持直接生成YAML格式的OpenAPI文档。YAML格式因其可读性强、结构清晰的特点，特别适合人工阅读和维护。

开发者可以通过简单的配置切换输出格式，或者同时支持两种格式的输出。这一特性为团队协作和文档管理提供了更多灵活性。

ProducesResponseType注解的增强

ProducesResponseType注解现在支持添加响应描述信息，这大大提升了API文档的可读性和实用性。这一增强适用于传统控制器和最小API两种编程模型。

在控制器中使用示例：

[HttpGet]
[ProducesResponseType(typeof(Todo), Status200OK, Description = "返回待办事项列表")]
[ProducesResponseType(Status400BadRequest, Description = "请求参数无效")]
public IActionResult GetTodos()
{
    // 实现代码
}

在最小API中使用示例：

builder.MapGet("/api/todos",
[ProducesResponseType(typeof(Todo), Status200OK, Description = "返回待办事项列表")]
[ProducesResponseType(Status400BadRequest, Description = "请求参数无效")]
() =>
{
    // 实现代码
});

此外，ProducesDefaultResponseType注解现在也支持描述信息，可以用于说明默认响应情况。

改进的顶层语句测试支持

针对使用C#顶层语句的应用程序，.NET 10 Preview 1提供了更好的测试支持。这一改进使得测试编写更加直观，减少了样板代码。

主要改进包括：

• 简化了测试项目的配置
• 改进了测试发现机制
• 提供了更好的错误诊断信息

这些改进使得开发者能够更轻松地为使用顶层语句的Web API应用编写集成测试和单元测试。

总结

.NET 10 Preview 1为ASP.NET Core Web API带来了多项实用改进，从文档生成到测试支持都有显著提升。这些新特性将帮助开发者构建更规范、更易维护的API应用，同时提高开发效率。建议开发者尽早尝试这些新功能，为正式版本的升级做好准备。