工程开发
Backend API avatar

Backend API

使用 Rust 和 Axum 设计并实现强健的 RESTful API 端点,涵盖路由、HTTP 方法、状态码与请求/响应处理,并确保符合仓库标准。

简介

此技能为 coreyja.com 基于 Rust 的代码库提供后端 API 逻辑实现的专业指导。它专为负责构建或维护服务器端基础设施的开发人员所设计,特别是使用 Axum Web 框架来定义资源导向端点的场景。该技能确保所有 API 开发均遵循 RESTful 原则,促进一致的命名规范、正确使用 HTTP 方法(GET、POST、PUT、PATCH、DELETE)以及标准化的响应格式。开发人员应在构建新 API 路由、修改现有控制器或配置 Web 框架中间件(如速率限制和错误处理)时利用此技能。

  • 使用 Axum 框架实现 RESTful API 路由和端点结构。

  • 配置 HTTP 请求处理,包括输入验证、参数解析和路径设计。

  • 定义和管理用于成功、客户端错误和服务器端失败的标准化 HTTP 状态码。

  • 设定 API 版本控制策略,以确保项目发展过程中的向后兼容性。

  • 通过特征(traits)和服务与项目特定的日志记录、追踪和数据库交互模块进行整合。

  • 维护路由定义、控制器逻辑和 API 处理模块中的干净代码标准。

  • 遵循现有项目模式开发嵌套资源路径和 RESTful 层级结构。

  • 优先使用 Axum 和 Tower 生态系统提供的类型安全 Rust 抽象。

  • 确保所有与 API 相关的逻辑位于适当的目录结构中,例如 server/ 或专用的控制器模块。

  • 参照仓库文档 (agent-os/standards/backend/api.md) 中定义的后端标准,以保持架构一致性。

  • 验证所有端点变更皆已涵盖在回归测试中,以确保服务稳定性。

  • 根据等幂性需求(例如 PUT 与 PATCH)应用适当的 HTTP 方法,以维持 REST 合规性。

  • 使用此技能来连接前端请求与后端服务逻辑,确保个人网站 API 层的资料流顺畅。

仓库统计

Star 数
6
Fork 数
1
Open Issue 数
14
主要语言
Rust
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 21:18
在 GitHub 查看