【求助】自动生成 API 文档极简方案

需求：在设计、研发后，能生成接口文档内容，包含如下表格示例的内容。每次修改接口后，生成新接口文档，免于设计、研发工程师再去手动改文档。尽量避免漏改使其 API 文档可用性低。

actionKeycontroller接口描述创建人创建时间
/admin/account/addRole...account.AccountAdminController添加角色张三2018年9月12日16:55:57
参数名称参数描述是否必填默认值参数类型参数备注
accountId账户id是-string
roleId角色id是-string
actionKeycontroller接口描述创建人创建时间
/admin/account/deleteRole...account.AccountAdminController删除角色张三2018年9月12日16:59:59
参数名称参数描述是否必填默认值参数类型参数备注
accountId账户id是-string
roleId角色id是-string

@JFinal 希望提点一个极简的方案

项目：JFinal

评论区

JFinal

2018-09-13 17:12

在开发的过程中严格写好注释，参数返回值都用 @param @return 注解弄好

再让你们的美工做个 html 模板，最后用 jfinal enjoy 针对该 html 写个生成器就可以了

代码应该在 200 行以内
 回复

欲风217

2018-09-14 08:09

@JFinal 首先感谢回复。其次有 2 点疑问
1. @param @return 是 javadoc 的注解还是自定义的注解？
2. 如果是 javadoc 的注解，如何获取该注解和内容呢？
 回复

JFinal

2018-09-14 09:50

@欲风217 这里都是讲的 javadoc 的注解，你一边开发一边写好注释，这样就顺带将 API 文档的事情搞定了

获得注解本身可以使用 Class.getMethod().getAnnotations() ， 内容部分可能要解析一下源代码
 回复

欲风217

2018-09-17 08:04

@JFinal 知道了，非常感谢。弄好后我搞一篇分享
 回复
我要反馈

热门反馈

扫码入社