22 Star 74 Fork 23

regan_org / Regan_API_SpringBoot

Create your Gitee Account
Explore and code with more than 5 million developers,Free private repositories !:)
Sign up
Clone or download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

Regan_API_SpringBoot

star fork

项目介绍

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

java源码

 /**
 * 用户管理
 * @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"));
    }

}

文档: https://zhangbiy.github.io/regan_api_doc/#/

版本

软件架构

软件架构说明 Regan API 基础项目基于 springboot 开发,前端基于飞冰开发的API接口文档管理项目。

欢迎加入 regan_org组织【编程爱好者】

Comments ( 11 )

Sign in for post a comment

About

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

Releases

No release

Gitee Metrics

Contributors

All

Activities

load more
can not load any more
Java
1
https://gitee.com/regan_org/Regan_API_SpringBoot.git
git@gitee.com:regan_org/Regan_API_SpringBoot.git
regan_org
Regan_API_SpringBoot
Regan_API_SpringBoot
master

Search

152606 8668e384 1899542 133635 2cd7d36e 1899542