.NET中的Web API用于构建RESTful服务，通过控制器处理HTTP请求，返回JSON/XML数据。使用名词表示资源（如/api/users），结合GET、POST、PUT、DELETE方法操作资源，返回标准状态码。示例中定义User模型和UsersController控制器，实现增删改查。建议启用模型验证、使用DTO、统一错误格式、集成Swagger文档，并支持分页与缓存，以提升API质量。遵循REST原则可构建高性能、易维护的接口。
.NET中的Web API 是 ASP.NET 框架的一部分，专门用于构建 HTTP 服务，通常返回 JSON 或 XML 格式的数据，供前端、移动端或其他后端系统调用。它不生成页面，而是提供数据接口，非常适合构建现代的前后端分离应用或微服务架构。
在 .NET 中，Web API 通过控制器（Controller）处理 HTTP 请求，使用特性路由、模型绑定、内容协商等机制，让开发者能快速创建高性能、可扩展的 RESTful 接口。
RESTful 风格的核心原则
设计符合 RESTful 风格的 API，关键是遵循资源导向和标准 HTTP 语义：- 用名词表示资源，不用动词。例如用
/api/users而不是/api/getUsers - 通过 HTTP 方法（GET、POST、PUT、DELETE）表达操作意图
- 使用正确的状态码返回结果，如 200（成功）、201（创建成功）、404（未找到）、400（请求错误）
- 保持无状态，每次请求都应包含完整信息
- 支持版本控制，如通过 URL 或请求头区分 v1/v2
在 .NET 中设计 RESTful API 的步骤
以一个用户管理功能为例，展示如何在 .NET 中实现：1. 定义资源模型
public class User
{
public int Id { get; set; }
public string Name { get; set; }
public string Email { get; set; }
}
2. 创建控制器并使用特性路由
[ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
private static List<User> _users = new List<User>();
// GET: api/users
[HttpGet]
public IActionResult Get() => Ok(_users);
// GET: api/users/5
[HttpGet("{id}")]
public IActionResult GetById(int id)
{
var user = _users.FirstOrDefault(u => u.Id == id);
return user == null ? NotFound() : Ok(user);
}
// POST: api/users
[HttpPost]
public IActionResult Create([FromBody] User user)
{
if (!ModelState.IsValid) return BadRequest(ModelState);
user.Id = _users.Count + 1;
_users.Add(user);
return CreatedAtAction(nameof(GetById), new { id = user.Id }, user);
}
// PUT: api/users/5
[HttpPut("{id}")]
public IActionResult Update(int id, [FromBody] User user)
{
var existing = _users.FirstOrDefault(u => u.Id == id);
if (existing == null) return NotFound();
existing.Name = user.Name;
existing.Email = user.Email;
return NoContent();
}
// DELETE: api/users/5
[HttpDelete("{id}")]
public IActionResult Delete(int id)
{
var user = _users.FirstOrDefault(u => u.Id == id);
if (user == null) return NotFound();
_users.Remove(user);
return Ok();
}
}
提升 API 质量的建议
除了基本结构，还需关注实际使用中的细节：- 启用模型验证，利用 Data Annotations 如
[Required]、[EmailAddress] - 统一错误响应格式，避免直接抛出异常信息
- 使用 DTO（数据传输对象）隔离内部模型与外部接口
- 添加 Swagger / OpenAPI 文档（通过 Swashbuckle.AspNetCore）
- 考虑分页、过滤、排序，尤其对集合资源
- 合理使用 HTTP 缓存、ETag 等机制提升性能
基本上就这些。.NET 的 Web API 提供了强大且简洁的方式构建 RESTful 服务，只要遵循资源抽象和 HTTP 规范，就能设计出清晰、易用、可维护的接口。
