Solon Docs 开发
Solon Docs 是用于构建接口文档。
标准规范 | 适配插件 | 备注 |
---|---|---|
OpenApi2 | solon-docs-openapi2, solon-openapi2-knife4j | |
OpenApi3 | 暂不支持 |
接口文档生成的过程:
- 构建“文档摘要”
- 框架根据“文档摘要”,生成文档模型(有些框架需要 swagger 注解,有些则基于 javadoc 生成)
- 通过接口把文档模型转为 json,则功能界面呈现
- 用户与功能界面交互
关于生成接口文档,具体参考相关插件。比如:solon-openapi2-knife4j,或者 smart-doc-maven-plugin