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

相关推荐
计算机毕业设计木哥1 小时前
计算机毕业设计 基于Python+Django的医疗数据分析系统
开发语言·hadoop·后端·python·spark·django·课程设计
Victor3561 小时前
Redis(52)Redis哨兵模式下如何进行版本升级?
后端
cyforkk10 小时前
Spring Boot @RestController 注解详解
java·spring boot·后端
canonical_entropy11 小时前
可逆计算:一场软件构造的世界观革命
后端·aigc·ai编程
重庆穿山甲11 小时前
从0到1:用 Akka 持久化 Actor + Outbox + RocketMQ 做到“订单-库存最终一致”
后端
我不只是切图仔12 小时前
我只是想给网站加个注册验证码,咋就那么难!
前端·后端
专注VB编程开发20年12 小时前
CSS 的命名方式像是 PowerShell 的动词-名词结构,缺乏面向对象的层级关系
开发语言·后端·rust
野犬寒鸦12 小时前
力扣hot100:相交链表与反转链表详细思路讲解(160,206)
java·数据结构·后端·算法·leetcode