跳转到内容

接口文档状态

仓库包含 jimuqu-common-doc 模块,但当前 POM 中的 OpenAPI/Javadoc 相关依赖均被注释,主 README 也把“基于注释生成接口文档”列为未完成计划。

因此当前版本不能把自动接口文档描述为已可用功能。开发时应以 Controller 源码、统一响应模型和本网站中的接口说明为准。

  1. 选择与 Solon 4 兼容的 OpenAPI 实现。
  2. 从 JavaDoc 和参数校验注解生成 schema。
  3. 统一描述 R<T> 和 PageResult<T>。
  4. 对需要登录、权限码和接口加密的端点增加安全说明。
  5. 在 CI 中生成静态规范并检查破坏性变更。