常见问题

EasyYapi 使用中的常见问题与解答。

配置

• 如何添加配置文件 — 向项目中添加配置文件

API 组织

• 如何将 API 分组到文件夹 — 将 API 组织到文件夹中
• 如何忽略 API — 从文档中排除 API
• 如何设置 API/文件夹名称/描述 — 自定义 API 名称和描述
• 如何标记 API 为废弃 — 标记 API 为废弃状态

权限

• 如何声明 API 权限 (javax) — 使用 javax.annotation.security
• 如何声明 API 权限 (Spring) — 使用 Spring Security

字段与类型

• 如何忽略字段 — 从文档中排除字段
• 如何转换类型 — 将一种类型转换为另一种
• 多种返回类型 — 处理不同返回类型的 API
• 多种类型的字段 — 处理具有多种可能类型的字段

验证

• 启用 javax.validation 分组 — 使用验证分组
• 启用 JsonIgnoreProperties — Jackson JsonIgnoreProperties 支持

故障排除

• 复杂类被阻止 — 解决"too complex"错误