Regan_API_SpringBoot 一个基于注释生成JAVA API文档的接口平台

最新推荐文章于 2023-05-31 19:36:48 发布

转载最新推荐文章于 2023-05-31 19:36:48 发布 · 316 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://my.oschina.net/jeffregan/blog/1939068

文章标签：

#java #python

Regan_API_SpringBoot项目基于注释自动生成api文档，能缩短API接口文档的开始与后期维护时间。它利用jdk的Doclet类读取文档注释，可手动配置读取文件，还有过滤指定方法等功能。该项目基于springboot开发，前端基于飞冰。

2019独角兽企业重金招聘Python工程师标准>>>

Regan_API_SpringBoot

项目介绍

Regan_API_SpringBoot 文档项目 Regan API 项目是基于注释自动生成api文档，很大缩短了开始与后期维护API接口文档的时间。Regan API 利用jdk提供的Doclet 类读取文档注释，可手动配置需要读取的文件，同时增加了读取过滤指定方法过滤等功能。

/**
* 用户管理
* @action /user
* @author zhangby
* @date 2018/6/12 下午3:26
*/
public class UserController extends Controller {
/**
 * 用户登录功
 * @title 登录接口
 * @param username|用户名|string|必填
 * @param password|密码|string|必填
 * @resqParam code|用户名|String|必填
 * @resqParam data|数据|object|非必填
 * @resqParam msg|消息信息|String|必填
 * @respBody {"code":"000","data":"","msg":"success"}
 * @requestType post,get
 * @author zhangby
 * @date 2018/6/12 下午4:23
 */
public void login() {
    renderJson(Kv.create().set("code","000"));
}
}