jfinal-swagger接口管理神器

禾雀花
2019-04-29 20:05

由于项目接口多变，苦于对接口的管理，随发现了swagger的神奇作用，于是借鉴了社区的某位大佬的代码改造了一番，可以简单使用。

源码：https://gitee.com/zdkhqh/JfinalSwagger

<dependency>
    <groupId>top.hequehua</groupId>
    <artifactId>jfinal-swagger</artifactId>
    <version>0.1.5</version>
</dependency>

使用示例：

使用方法：

添加路由
添加前端处理器
配置插件

由于返回前端的数据为了安全和省流量，只传前端需要的字段：

于是用Dto返回：Model --> XXXDto (model转换为java对象)

项目：JFinal

23 13

评论区

l745230

2019-04-30 08:27

跟其他几个版本jfinal-swagger比起来,你这套标签好不好用还不知道.但是前端UI已经赢了.

禾雀花

2019-04-30 08:51

@l745230 前端UI用的是swagger-bootstrap-ui(Author: xiaoyumin)

kumi

2019-04-30 10:12

启动项目报错
java.lang.ClassCastException: com.tpson.swagger.routes.MySwaggerRoutes cannot be cast to com.jfinal.config.Routes

kumi

2019-04-30 10:27

@kumi 我用的你的jar包，但是我如果把你的项目直接集成进去就没问题，是jar包的问题吗

l745230

2019-04-30 11:14

@禾雀花高端大气上档次的前端UI.不错不错

kumi

2019-04-30 11:55

我现在手动集成进去之后，访问127.0.0.1/swagger 报404

禾雀花

2019-04-30 12:29

@kumi 重新拉下代码，或者自己打包试下，404看下使用方法2配置了没

禾雀花

2019-04-30 12:32

@kumi 127.0.0.1/swagger这个访问去掉了，用127.0.0.1/doc.html

kumi

2019-04-30 12:40

@禾雀花谢谢，可以访问了，但是新的问题是我写了controller没有识别，basepackage设置的我controller的目录

禾雀花

2019-04-30 13:12

@kumi 然后每个controller要加上注解如@Api(description = "登陆相关接口")

kumi

2019-04-30 17:31

@禾雀花每个Controller都添加了@Api(description = "xxx"),每个接口也写了你图上那些注解，，可还是没有识别到我的Controller

禾雀花

2019-04-30 19:03

@kumi 插件配置了吗 docApiUrl参数这个不要变（"swagger/api"）,这个是请求数据的接口
me.add(new SwaggerPlugin(WebConfig.enable_swagger)
.addSwaggerDoc(
new SwaggerDoc("127.0.0.1", "XXX.controller", "WEB端接口", "swagger/api"))
);

kumi

2019-05-02 14:07

@禾雀花我发现问题了，好像在configRoute方法里面只能addRouter才生效，addController不生效

yyyyangzi

2019-05-05 11:17

请问大佬 apiResponse 中的dto怎么写?

nommpop

2019-05-05 11:24

@禾雀花我这边总是报这个错误,请问是什么原因
java.lang.NoClassDefFoundError: org/apache/commons/io/IOUtils
at top.hequehua.swagger.handler.WebJarsHandler.handle(WebJarsHandler.java:41)
at com.jfinal.core.JFinalFilter.doFilter(JFinalFilter.java:86)

禾雀花

2019-05-05 13:13

@yyyyangzi
@ApiModel(description = "图片上传成功后返回的信息")
public class PhotoDto {
@ApiParam(description = "图片id")
private Integer id;
@ApiParam(description = "图片MD5值")
private Integer md5;
@ApiParam(description = "图片地址")
private Integer url;
@ApiParam(description = "图片原文件名")
private String originalFileName;
@ApiParam(description = "图片类型")
private String fileType;
@ApiParam(description = "图片宽度")
private Integer width;
@ApiParam(description = "图片高度")
private Integer height;
@ApiParam(description = "图片上传时间")
private Integer addTime;
}