jfinal-swagger讓你的應用接口更加簡單

前言

前兩天逛jfinal社區，看到jfinal-swagger項目，接觸到swagger，研究了一番對部分代碼進行修改，成功整合到LMS，支持jfinal 多模塊掃描，去除冗餘依賴，修改try it out 問題等 。具體代碼使用請見LMS。

Swagger 是一個規範和完整的框架，用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。整體目標是使客戶端和文件系統做爲服務器以一樣的速度來更新。文件的方法，參數和模型緊密集成到服務器端的代碼，容許API來始終保持同步。 Swagger 讓部署管理和使用功能強大的API從未如此簡單。

配置方法

1. 下載jfinal-swagger到本地，具體問題修改參考LMS的common模塊，而後mvn clean install。

<dependency>
    <groupId>com.feizhou</groupId>
    <artifactId>jfinal-swagger</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

2.下載你喜歡的 swagger-ui組件包： https://github.com/swagger-api/swagger-ui

將資源文件放入到webapp下，（不要求路徑和我一致做參考），** 注意修改 index.html 文件中的資源路徑，搞成絕對路徑最好啦 **

3. 添加一個 swagger的路由，** 注意對應上文中的資源路徑 **

add("/swagger", SwaggerController.class);

開始使用

@Api(tag = "user", description = "用戶管理")
public class SysUserController extends BaseController {
    /**
     * 刪除用戶
     */
    @ApiOperation(url = "/admin/user/userDel", tag = "user", httpMethod = HttpMethods.GET, description = "用戶刪除")
    @Params({@Param(name = "id", required = true, dataType = DataType.INTEGER, description = "用戶ID")})
    @RequiresPermissions("user:del")
    public void userDel() {
        int userId = getParaToInt("id");
        userService.deleteUserById(userId);
        renderSuccess("刪除成功");
    }
}

結果