asp.net core api RESTful 风格控制器

ASP.NET Core API 中,遵循 RESTful 风格的控制器一般具备以下几个关键特征:

✅ RESTful 风格控制器的命名规范

控制器命名

  • 使用 复数名词 ,表示资源集合,如 ProductsControllerUsersController

路由风格

  • 路由使用 [Route("api/[controller]")],自动绑定控制器名。

  • 路由中不包含动词,操作由 HTTP 方法来表达。

cs 复制代码
[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
    // 示例方法如下
}

✅ RESTful 对应的 HTTP 方法与语义

HTTP 方法 路由示例 含义
GET /api/products 获取所有产品
GET /api/products/1 获取 ID 为 1 的产品
POST /api/products 新建产品
PUT /api/products/1 更新 ID 为 1 的产品
DELETE /api/products/1 删除 ID 为 1 的产品

✅ 示例控制器代码

cs 复制代码
[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
    // GET: api/products
    [HttpGet]
    public IActionResult GetAll()
    {
        var products = new List<string> { "Apple", "Banana", "Orange" };
        return Ok(products);
    }

    // GET: api/products/5
    [HttpGet("{id}")]
    public IActionResult GetById(int id)
    {
        var product = $"Product {id}";
        return Ok(product);
    }

    // POST: api/products
    [HttpPost]
    public IActionResult Create([FromBody] string product)
    {
        // 假设添加成功
        return CreatedAtAction(nameof(GetById), new { id = 123 }, product);
    }

    // PUT: api/products/5
    [HttpPut("{id}")]
    public IActionResult Update(int id, [FromBody] string product)
    {
        // 假设更新成功
        return NoContent();
    }

    // DELETE: api/products/5
    [HttpDelete("{id}")]
    public IActionResult Delete(int id)
    {
        // 假设删除成功
        return NoContent();
    }
}

✅ RESTful 最佳实践

  1. 使用状态码准确表达结果

    200 OK, 201 Created, 204 No Content, 400 Bad Request, 404 Not Found 等。

  2. 请求体与响应体结构统一

    推荐使用统一格式返回结果(如包裹成标准响应结构)。

  3. 避免在 URL 中加入动词

    错误示例:/api/getProductById/1

  4. 使用分页查询时,遵循统一格式

    /api/products?page=1&pageSize=10

相关推荐
青柠编程3 小时前
基于Spring Boot的选课管理系统架构设计
java·spring boot·后端
码事漫谈5 小时前
C++内存泄漏排查:从基础到高级的完整工具指南
后端
王嘉俊9255 小时前
ThinkPHP 入门:快速构建 PHP Web 应用的强大框架
开发语言·前端·后端·php·框架·thinkphp
码事漫谈5 小时前
C++多线程数据竞争:从检测到修复的完整指南
后端
Code blocks6 小时前
SpringBoot快速生成二维码
java·spring boot·后端
朝阳5817 小时前
使用过程宏实现自动化新增功能
后端·rust
大厂码农老A7 小时前
P10老板一句‘搞不定就P0’,15分钟我用Arthas捞回1000万资损
java·前端·后端
Pomelo_刘金7 小时前
常见的幂等方案
后端
tonydf7 小时前
Blazor Server项目里,集成一个富文本编辑器
后端
文心快码BaiduComate7 小时前
文心快码已接入GLM-4.6模型
前端·后端·设计模式