API 设计指南

概述

本模块提供 RESTful API 设计规范，确保前后端接口的一致性和可维护性。

规范列表

核心规范

• RESTful 规范 - 资源命名、HTTP 方法、状态码
• 响应格式 - 统一响应体、错误格式
• 错误码设计 - 错误码分类、编号规则
• 认证授权 - JWT、OAuth2、权限控制

快速查找

场景导航

• 设计 RESTful API → RESTful 规范
• 定义响应格式 → 响应格式
• 设计错误码 → 错误码设计
• 实现认证授权 → 认证授权

相关文档

• 后端开发规范 - Echo 框架实现
• 数据库设计 - 数据模型设计