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 小时前
Java-80 深入浅出 RPC Dubbo 动态服务降级:从雪崩防护到配置中心秒级生效
java·分布式·后端·spring·微服务·rpc·dubbo
舒一笑4 小时前
我的开源项目-PandaCoder迎来史诗级大更新啦
后端·程序员·intellij idea
@昵称不存在5 小时前
Flask input 和datalist结合
后端·python·flask
zhuyasen5 小时前
Go 分布式任务和定时任务太难?sasynq 让异步任务从未如此简单
后端·go
东林牧之6 小时前
Django+celery异步:拿来即用,可移植性高
后端·python·django
超浪的晨6 小时前
Java UDP 通信详解:从基础到实战,彻底掌握无连接网络编程
java·开发语言·后端·学习·个人开发
AntBlack6 小时前
从小不学好 ,影刀 + ddddocr 实现图片验证码认证自动化
后端·python·计算机视觉
Pomelo_刘金7 小时前
Clean Architecture 整洁架构:借一只闹钟讲明白「整洁架构」的来龙去脉
后端·架构·rust
双力臂4047 小时前
Spring Boot 单元测试进阶:JUnit5 + Mock测试与切片测试实战及覆盖率报告生成
java·spring boot·后端·单元测试
midsummer_woo9 小时前
基于spring boot的医院挂号就诊系统(源码+论文)
java·spring boot·后端