生成API接口文档设计
你是一位资深的后端技术专家,擅长设计符合RESTful规范、安全高效的API接口。 请为`社交媒体平台`的`用户内容管理模块`设计一套完整的API接口文档,供前端和移动端团队使用。 API接口文档需包含以下内容: 1. 文档概述: - API版本信息 - 基础URL - 认证方式说明 - 通用请求/响应格式 - 状态码与错误处理规范 2. 认证与授权: - 认证机制详解(OAuth 2.0/JWT等) - 权限模型设计 - 接口权限要求说明 - Token管理机制 - 安全最佳实践 3. 资源模型: - 核心资源定义 - 资源间关系说明 - 字段类型与格式规范 - 示例资源对象 4. 接口清单: - 接口分组与概览 - 接口命名规范 - 版本控制策略 - 废弃策略 5. 详细接口规格: (对每个接口包含以下内容) - 接口名称与描述 - HTTP方法与路径 - 路径参数说明 - 查询参数说明 - 请求头要求 - 请求体格式与示例 - 响应格式与示例 - 状态码与错误响应 - 速率限制说明 - 特殊处理说明 6. 批量操作设计: - 批量创建/更新/删除接口 - 分页机制设计 - 筛选与排序参数设计 - 部分响应设计(字段过滤) 7. Webhook设计: - 事件类型定义 - 订阅机制 - 消息格式 - 重试与确认机制 8. SDK与代码示例: - 常见语言调用示例 - SDK使用指南 - 典型业务场景的调用流程 9. 最佳实践与注意事项: - 性能优化建议 - 缓存策略 - 并发处理 - 常见问题解答 10. 附录: - 术语表 - 更新日志 - 废弃接口列表 - 相关资源链接 要求: - 接口设计需符合RESTful API设计最佳实践 - 文档需详细、清晰,包含充分的示例 - 考虑API的可扩展性、向后兼容性和版本控制 - 安全性设计需符合OWASP安全标准 - 遵循OpenAPI 3.0规范,便于生成交互式文档 请以Markdown格式输出完整的API接口设计文档。
Java 编程规范助手
以下是 Java 编码规则与指南,适用于现代 Java 项目开发(包括 Spring Boot 等主流技术栈),尤其在强调清晰架构、可测试性和工程实践方面保持一致性。你可以复制保存为 rules.md: 编码规则与指南(Java 版) 测试驱动开发(TDD)优先,使用 JUnit 和 Mockito: 在编写实现代码之前先编写失败的测试(红-绿-重构)。使用 JUnit 5 和 Mockito 进行单元测试、Mock 注入与验证。KISS 原则(保持简单,傻瓜式): 实现中优先选择最简单的可行方案,避免过度设计。DRY 原则(不要重复自己): 抽象公共逻辑至方法、类或模块中,避免冗余代码。优先使用标准库与成熟依赖: 利用 Java 标准库(如 java.time, java.util, java.net.http)和经过良好维护的依赖(如 Lombok, Jackson, Apache Commons, SLF4J)。YAGNI 原则(你不会需要它): 不要为未来的假设需求而编写代码,仅实现当前明确需要的功能。SOLID 原则与可扩展性: 遵循 SOLID 原则,编写高内聚、低耦合的类和接口,以提高可维护性和可扩展性。遵循 Google Java Style 或标准 Java 格式规范: 使用统一的格式化工具(如 google-java-format 或 IDE 默认格式化器)。类型安全与泛型优先: 尽可能使用泛型与类型检查机制,避免原始类型和类型转换。Javadoc 注释: 为每个类、方法和公开接口提供清晰的 Javadoc,包括其职责、参数和返回值说明。单一职责原则: 每个类或方法应承担单一职责,避免类过大或方法过长。模块化设计: 将项目拆分为职责清晰、可复用、可单元测试的模块(例如通过 Spring Bean、模块包结构划分等)。使用参数绑定和 ORM 查询防止 SQL 注入: 使用 JPA、MyBatis 等 ORM 工具,并始终使用参数绑定而非拼接 SQL。存储灵活结构数据使用 JSON 字段(如 PostgreSQL 的 JSONB): 封装成 VO/DTO 模型并使用 Jackson/Gson 等库解析。统一日志记录: 使用 SLF4J 与实现(如 Logback)进行日志记录,按 DEBUG/INFO/WARN/ERROR 等级记录重要信息。配置与容器化: 使用 application.yml / application.properties 管理配置,从环境变量注入敏感配置。使用 Dockerfile 和 docker-compose.yml 管理容器。工具类集中管理: 将通用工具函数集中于 Utils / Helper 类,保持代码整洁和复用性。测试数据使用 Fixtures 或 Builder 模式组织: 为测试场景准备静态数据或使用对象构建器。编写高效代码: 避免不必要的计算、过深的循环、重复数据库访问等低效操作。有意义的返回值与异常处理: 方法应返回明确结果(非 magic 值),合理使用异常机制。使用 Maven 自动化构建与依赖管理: 标准化构建流程与版本控制。优雅地处理数据库异常: 捕获 SQLException 或 ORM 异常并转化为业务层异常,提供清晰错误信息。安全与密钥处理: 所有敏感信息应来自环境变量或安全配置管理(Nacos)。遵循指令优先: 精确遵循任务需求和设计规范,如遇不明确应及时沟通确认。全面文档与注释: 包括类/方法 Javadoc,必要的 inline 注释,以及完善的 README.md 说明项目背景与使用方法。使用 MyBatis Plus 进行 ORM 映射: 推荐使用MyBatis Plus进行数据库操作。使用 Bean Validation 进行参数验证: 使用 javax.validation / jakarta.validation 和注解如 @NotNull, @Size, @Valid 进行参数校验。异步编程(如有需要): 使用 CompletableFuture、Spring @Async、Reactor 处理异步任务和响应式编程。RESTful API 设计规范: 正确使用 HTTP 方法,设计资源导向的 URI,返回标准 HTTP 状态码和 JSON 格式响应。API 版本控制: 在 URI 路径中加入版本前缀(如 /api/v1/...),实现 API 升级的可管理性。速率限制(如有需要): 实现 IP 或 Token 级别的速率限制,防止接口滥用。依赖管理规范化: 使用 pom.xml 明确声明依赖与版本,避免依赖冲突。使用 try-with-resources 管理资源: 关闭数据库连接、文件流等应使用自动关闭机制,避免资源泄漏。倾向使用不可变对象(如 record / final class): 在 DTO、常量值对象中优先使用不可变设计。