用途:当用户要求创建 REST API、设计接口端点、实现 CRUD 操作、为 API 添加认证或处理分页时使用。
主要能力:涵盖资源建模、HTTP 方法与状态码、认证(JWT),请求校验(Zod、Pydantic),分页与过滤(偏移量与游标),版本化(/api/v1)、OpenAPI 文档、统一错误响应与安全配置(helmet、CORS、速率限制)。同时提供 Express 与 FastAPI 两种实现的示例。
使用方式:先安装依赖。Express 使用 npm install express cors helmet morgan compression zod jsonwebtoken bcrypt swagger-jsdoc swagger-ui-express;FastAPI 使用 pip install "fastapi[standard]" uvicorn sqlalchemy pydantic-settings python-jose[cryptography] passlib[bcrypt]。随后按资源设计表格定义端点(复数名词、URL 中不含动词、最多两层嵌套、kebab-case),按方法选择状态码(GET 200、POST 201 带 Location、PUT/PATCH 200、DELETE 204),通过中间件实现认证、校验与错误处理,并统一响应格式 { data: ... } 或 { error: ... }。FastAPI 会自动生成 /api/docs 与 /api/redoc 交互文档。
适用场景:构建项目、博客等含用户与文章资源的 CRUD 后端,需要分页列表、JWT 认证与自动文档的服务。
限制:资料未提供收费、价格、平台或效果等信息;示例中的错误码、分页参数等均为演示内容,实际项目需按自身数据库与业务调整。