jfinal-swagger接口管理神器

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

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

  1. <dependency>
  2.     <groupId>top.hequehua</groupId>
  3.     <artifactId>jfinal-swagger</artifactId>
  4.     <version>0.1.5</version>
  5. </dependency>


使用示例：

image.png

image.png


使用方法：

  1. 添加路由image.png

  2. 添加前端处理器image.png

  3. 配置插件image.png



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

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

image.png

项目：JFinal
23 13

评论区

禾雀花

2019-05-06 17:14

多个包下面的controller不需要重新添加SwaggerDoc（SwaggerDoc是接口分类使用的）；没返回东西不需要写ApiResponse
 回复

l745230

2019-05-10 14:39

传到maven上啊,这样导入也方便
 回复

禾雀花

2019-05-16 10:04

终于把包发布出去了。。。

top.hequehua
jfinal-swagger
0.1.5
 回复

yyyyangzi

2019-05-16 10:23

大佬,请求参数可以用自定义的实体类对象么?
 回复

禾雀花

2019-05-16 10:28

@yyyyangzi
可以的
在接口上加注解@ApiRequests(request = RechargePageVo.class)
然后RechargePageVo类里的各属性加上注解 @ApiParam(description = "查询添加开始时间")
 回复

禾雀花

2019-05-16 10:29

@l745230
已经上传上去了啦啦啦

top.hequehua
jfinal-swagger
0.1.5
 回复

yyyyangzi

2019-05-16 14:36

swagger model 老是添加不上...不知道为什么
 回复

禾雀花

2019-05-16 15:03

@yyyyangzi 哪里
 回复

指缝

2019-05-24 13:19

使用调试功能POST，raw,json（application/json）时传进服务器的参数是这样的userName=%E9%83%AD&password=123，正常不应该是{"userName":"asd","password":"qwe"}这样么
 回复

hrrelive

2019-06-18 09:02

集成之后不能启动啊，报这个错。Info: jfinal-undertow 1.6, undertow 2.0.19.Final, jvm 1.8.0_152
Exception in thread "main" java.lang.VerifyError: Bad type on operand stack
Exception Details:
Location:
com/sxjlrj/common/config/MainConfig.configRoute(Lcom/jfinal/config/Routes;)V @8: invokevirtual
Reason:
Type 'top/hequehua/swagger/routes/MySwaggerRoutes' (current frame, stack[1]) is not assignable to 'com/jfinal/config/Routes'
Current Frame:
 回复

huang4095

2019-07-09 15:49

有没有使用demo啊，一直引用不成功
 回复

huang4095

2019-07-09 16:00

me.add(new SwaggerPlugin(WebConfig.enable_swagger)
.addSwaggerDoc(
new SwaggerDoc("127.0.0.1", "XXX.controller", "WEB端接口", "swagger/api"))
); -------------------没有这个啊WebConfig.enable_swagger 这个报错
 回复

BigSnake1989

2019-08-09 09:39

请问下undertow下如何配置呢
 回复

BigSnake1989

2019-08-09 10:07

如果使用undertow配置了undertow.contextPath，在接口调试的时候，url缺少contextPath，这个有什么解决方案吗
 回复

tianci121404

2019-09-20 13:54

@ApiResponses({ @ApiResponse(code = "200", message = "成功",response=UserInfo.class)})
目前只能支持这样的吗？返回值如果是map就不行了，能不能支持在注解上直接写@ApiParam
 回复

zhangchuang

2019-09-28 17:40

undertow 不能用
 回复

cs3230524

2019-09-30 12:49

前端展示不支持循环VO引用吗？
 回复

cs3230524

2019-09-30 14:05

不支持泛型么？也不支持继承
 回复

cs3230524

2019-09-30 21:08

List也不能用吗？
 回复

苏伟伟

2019-10-08 16:43

@禾雀花 undertow下找不到controller
 回复

koolss

2019-12-10 15:24

我这边集成后是这样得问题 大佬求解
已导入maven：commons-io 2.5、jfinal-swagger 0.1.5

已配置：me.add(new MySwaggerRoutes());、me.add(new WebJarsHandler());


Exception in thread "main" java.lang.VerifyError: Bad type on operand stack
Exception Details:
Location:
com/koolss/common/config/JfinalConfig.configRoute(Lcom/jfinal/config/Routes;)V @8: invokevirtual
Reason:
Type 'top/hequehua/swagger/routes/MySwaggerRoutes' (current frame, stack[1]) is not assignable to 'com/jfinal/config/Routes'
Current Frame:
bci: @8
flags: { }
locals: { 'com/koolss/common/config/JfinalConfig', 'com/jfinal/config/Routes' }
stack: { 'com/jfinal/config/Routes', 'top/hequehua/swagger/routes/MySwaggerRoutes' }
Bytecode:
0x0000000: 2bbb 0013 59b7 0014 b600 1557 2bbb 0016
0x0000010: 59b7 0017 b600 1557 2bbb 0018 59b7 0019
0x0000020: b600 1557 2bbb 001a 59b7 001b b600 1557
0x0000030: 2bbb 001c 59b7 001d b600 1557 2bbb 001e
0x0000040: 59b7 001f b600 1557 b1
 回复

程序员是真的雷

2019-12-24 15:23

我的问题和上面那个兄弟一样，出不来
 回复

程序员是真的雷

2019-12-24 15:23

我今天试了jfianl的3个swagger，全都不行，服了
 回复

程序员是真的雷

2019-12-24 16:16

@huang4095 那是她自己定义的全局变量，你写个true就行
 回复

程序员是真的雷

2019-12-24 16:18

@kumi 我这边几种都试了，addroute和直接add类，反正就是出不来
 回复
我要分享

热门分享

扫码入社