Regan_API_SpringBoot 一個基於註釋生成JAVA API文檔的接口平臺

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"));
}
}

文檔： https://zhangbiy.github.io/regan_api_doc/#/

版本

• Jfinal: https://gitee.com/regan_org/jfinal-api
• springboot: https://gitee.com/regan_org/Regan_API_SpringBoot

軟件架構

軟件架構說明 Regan API 基礎項目基於 springboot 開發，前端基於飛冰開發的API接口文檔管理項目。