RESTful API

RESTful API

  • Representational State Transfer 表述性状态转移,RESTful 即表示符合 REST 特性的(如果一个架构符合 REST 原则,就称为 RESTful 架构)
  • RESTful API 是一种基于 HTTP 标准的设计风格和架构原则(接口设计规范),其核心思想是利用 URI 资源定位(统一的接口)和标准 HTTP 方法实现客户端与服务器之间的数据通信交互(通过 URI 统一资源标识符,通过标准 HTTP 方法操作资源),具有跨平台、简洁轻量级、灵活可扩展和易维护的特点
  • 统一接口:使用 GET、POST、PUT、DELETE 等标准 HTTP 方法表示操作,每个资源都有一个唯一的 URI 来标识
  • 无状态性:每次请求都必须包含足够的必要信息来完成该请求,服务器不维护上下文信息,更加灵活可扩展性(服务器无需维护 Session 会话状态),提升安全性(服务器不存储身份验证凭证)

设计规范

  • 使用名词而非动词(每个地址代表一种资源):比如用 GET /users 表示获取(读取)用户列表而不是 GET /getUsers
  • 版本控制:/api/v1/users 在路径中添加版本号
  • 资源嵌套(嵌套层级不超过两层):/users/123/orders 表示指定用户的订单列表
  • GET 获取资源(Read):使用 GET /orders 获取订单列表(名词复数形式),使用 GET /orders/123 获取指定订单
  • POST 创建新资源(Create):使用 POST /orders 创建一个新的订单
  • PUT 完全更新资源(Update,覆盖整个资源):使用 PUT /orders/123 修改指定订单
  • PATCH 部分更新资源(Update):使用 PATCH /orders/123 修改指定订单
  • DELETE:删除资源(Delete):使用 DELETE /orders/123 删除指定订单

总结

  • RESTful 通过标准化接口和资源化设计,是目前非常主流的 API 设计风格,尤其适用于需要高扩展性和跨平台兼容的场景
  • 通过标准 HTTP 方法定义操作类型,结合 URI 统一资源标识符来实现标准化数据交互
  • RESTful 理念就是将系统中的一切视为资源,使用标准 HTTP 方法(比如 GET、POST、PUT、DELETE 等)对资源进行增删改查(CRUD)操作
相关推荐
想要成为糕糕手3 小时前
RESTful Todo 任务清单 —— 从零学习前后端
api·restful·bun
Alan_756 小时前
SpringBoot API参数校验
api
网安情报局2 天前
告别排队与高延迟:直连GPT全系列,解锁低门槛、高稳定的AI生产力
人工智能·gpt·api·ai大模型
天空属于哈夫克33 天前
企微 RPA 接口开放:无需官方权限,外部群自由操作
自动化·企业微信·api
ZorChi4 天前
AI API 调用优化实战:统一入口与超时处理指南
人工智能·aigc·接口·api·agent·token·中转站
Resistance丶未来4 天前
管控用量,降本增效,MAI Gateway:助力企业搭建 Tokens 统一管理体系
人工智能·大模型·api·claude·ai安全·魔芋ai·maigateway
星浩AI4 天前
Agnes AI 免费 API 接入指南:文本、生图、生视频,一套接口全免费
llm·api·claude
触底反弹5 天前
大模型时代:5 个 Prompt 替代 BERT 训练,搞定 NLP 五大任务
人工智能·node.js·api
极连AI5 天前
国产大模型譬如DeepSeek接入codex教程分享
人工智能·gpt·chatgpt·api·token·极连ai·zovelox.com
MageGojo6 天前
OCR 火车票识别 API 服务介绍与使用考量
ocr·接口·api·数据提取·火车票识别