JFinal-RunApi-接口文档管理系统

JFinal-RunApi是集swagger和postman于一身的接口管理系统。

它有四大能力

1、它拥有swagger一样的能力,却没有swagger那样繁琐的注解

2、它拥有postman一样的接口调试能力;

3、它拥有一键生成接口文档的能力;

4、它拥有个性化的接口文档分享能力

拥有这三大功能的JFinal-RunApi会是你的期待吗,来来,绝对的干货,就在这里就见证它的诞生吧。

JFinal-RunApi源码下载地址: jfinal-runapi.rar

一、一键同步系统的接口信息:

  • 通过调用/runapi/batchSync接口同步数据,demo代码:com.jfinal.app.runapi.runapi.ctrl.RunApiDemoController

image.png


二、搜索要调试的接口,进行个性化的调试:

1、搜索目标接口,点击调试: image.png

2、进入接口调试界面:

 image.png


3、输入接口参数,点击发送,查看接口请求结果:

image.png

image.png



4、以上三步就是调试接口,可以反复调试。调试没问题了,就可以把调试的结果直接保存生成文档,同时可以选择下面的一些内容进行补充

请求参数说明、成功返回示例、失败返回示例、接口备注

特别说明:接口返回示例的参数是一键解析json数据,自动生成,同时可以自由拖动排序,也可以手动添加参数说明;

如果是接口数据更新了,也可以放心的一键生成,之前的参数信息也不会丢失,所有大家可以随心所欲的调试接口了。

image.png


5、接口调试完成之后,点击保存,就可以把调试的信息生成标准的接口文档了。点击右上角的文档链接即可查看,效果图如下:

   image.png      image.png      image.png


6、生成的接口文档信息是可以分享

 image.png


7、导出离线html文档:可以导出全部或者安搜索条件导出单个文档

image.png




JFinal-RunApi-v2.0以后,完全实现独立运行部署,无论你的项目是前后分离、还是jfinal、springboot项目都可以使用JFinal-RunApi,只需要把run_api的表复制一份到你的项目里面,在项目里面把接口数据存进去,然后通过JFinal-RunApi的数据源功能进行关联,就是使用JFInal-RunApi的功能了。

image.png


8、接口文档分享功能

通过分享功能实现接口文档个性化管理,如:要分享哪些接口,分享连接有效期、是否需要密码访问等等

image.png

image.png

需要密码访问:

image.png

image.png

JFinal-RunApi的诞生,解决了JFinal开发者的一个痛点,大大提升了后端攻城狮的开发效率,也让前后端对接变得更加高效,后端写接口文档再也不用担心了,前端看着标准的文档心情也舒畅了,JFinal的攻城狮从今天起可以告别swagger的烦恼了,JFinal-RunApi是JFinal天然的产品,它的诞生得益于JFinal精巧的路由设计,才有了JFinal-RunApi的诞生,我们是在巨人的肩旁上腾飞,所以希望JFinal-RunApi可以帮助更多的开发者,助力JFinal的生态发展。


一切都为了让你的开发效率达到最高,有需要的同学一杯咖啡拿走(¥39)^_^  

     

JFinal-RunApi源码下载地址: jfinal-runapi.rar

--------------------------------------------------------------------------------------------------

来自JFinal作者的点评:

1、这个创新消解掉了swagger那些用起来并不直观的注解,极大减少了接口文档生成的工作量,用起来十分方便;

2、jfinal周边难得出现这样的创新,大大的赞;

3、这里创造性的去通过实际去请求项目,得到具体响应,然后将这个请求,响应保存api文档

4、以前波总也一直在找比swagger更简洁的方案,一直没找到,jfinal-runapi这个项目做到了

-------------------------------------------------------------------------------------------

jfinal-runapi解决了波总一直想解决却没有解决的问题,而这个解决方案和jfinal的路由设计天然的吻合,非常符合jfinal的极简设计,所有波总才会这么毫不吝啬的赞美,jfinal-runapi的核心不是为了团队协作写接口文档,记住,你用别的什么apifox,那不是jfinal-runapi的重点,jfinal-runapi的另外两个能力才是你其他框架所不具备的,以极小的工作量,完成api文档开发,天然具备私有化部署(接口文档再第三方平台,存在一定的风险),jfinal-runapi集三大能力于一身,你还能找一个框架来代替它的三大能力吗,还能这么高效率的开发吗?。

f298375bde7c0a0e6cd81ee83620bbfe.jpg

6316f27accec426a99bf005c5363880a.jpg

0bd5bfd142a44886b94ec5054d2779d9.jpg

版本更新记录:

image.png

最新版界面:

image.png


JFinal-RunApi源码下载地址: jfinal-runapi.rar




评论区(0)

顶部 客服 微信二维码 底部
>扫描二维码关注最代码为好友
扫描二维码加琴海森林为好友