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

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

它有四大能力

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

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

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

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

项目源码:JFinal RunApi

演示地址:http://runapi.qinhaisenlin.com/,账号:dev,密码:dev@123.com

技术交流QQ群:754344060

V4.0新版界面(2024-07-22):

image.png

一、项目管理

    1、新增项目,接口同步需要准备工作:将demo代码:com.jfinal.app.runapi.runapi.ctrl.RunApiDemoController拷贝到你的项目中,这个主要是提供一个接口给JFinal RunApi 同步接口调用。代码如下:

image.png

2、将上面的接口地址填写到项目的同步接口地址:

image.png

3、接口同步:

image.png


4、接口调试:

    在同步接口之后,就可以进入接口调试窗口,对接口进行分组管理,可以添加目录,移动和排序接口,然后把需要调试的接口调试保存。

A、添加目录:

image.png

B、排序移动:

image.png

C、调试接口:

image.png

d、右键菜单功能:

    点击目录右键可以快速添加目录、子页面。

image.png

E、右键接口菜单,可以克隆和删除:

image.png

5、接口管理:

这个主要是作为后端接口的管理,便于查询和管理。

image.png

6、文档管理:

查询已经保存文档的接口。

image.png

7、团队&成员:

    这里是对项目权限的管理,只有项目成员才能查看该项目的相关接口数据,成员分为:只读成员,编辑成员,项目管理员三个权限级别,只有项目管理员才有删除项目权限和添加编辑项目成员权限。

image.png

8、项目分享:

每个项目有一个分享地址,分享地址可以设置公开或者密码访问(没有调试生成文档的接口是不会共享)。

image.png

image.png


二、分享管理:

这里的分享是个性化的文档分享,可以多个项目文档一起分享,选择需要公开的接口文档即可。

image.png

1、新增、编辑分享,可以设置看公开或者密码访问,也可以设置链接的时效性,长期或者限期,设定到期时间,链接自动失效。

image.png

2、接口:

选择和查看分享的接口:

image.png

3、文档:

查看和管理已经选择的接口文档,可以新增目录,对接口文档进行分类和排序:

image.png

3、分享地址:

复制分享链接,发给对方即可

image.png


三、用户管理:

    新增用户,分配角色和重置密码。

image.png

image.png

四、角色管理:

    分配角色用户和角色权限,未授权的接口是不能正常访问的。

image.png

5、团队管理:

    根据团队来管理项目和成员权限。

image.png

image.png


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

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

image.png


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

image.png


七、分享链接密码访问:

image.png



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

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

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

来自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


版本更新记录:

jfinal-runapi-v4.0 2024.06.13
1、新增用户、角色、权限、团队功能模块
2、新增项目数据权限,项目团&队成员
3、优化项目接口调试界面,多tab展示
4、优化项目同步接口
5、优化登录功能
6、优化文档界面

jfinal-runapi-v3.0 2023.06.11
1、新增管理首页
2、新增文档目录功能
3、新增文档排序功能
4、新增项目文档管理页面
5、优化分享管理功能
6、屏蔽数据源接入方式

jfinal-runapi-v2.2.1 2023.05.22
1、优化调试接口,自动携带cookies信息,解决调试业务接口需要身份认证的问题
2、优化复制功能,保留代码格式
3、新增文档排序

jfinal-runapi-v2.2.0 2023.02.10
1、新增后端发起请求,解决了跨域的问题
2、优化调试界面

jfinal-runapi-v2.1.1 2023.01.12
1、优化分享功能界面
2、优化LoginIntecepter拦截器
3、新增ExceptionIntecepter拦截器

jfinal-runapi-v2.1.0 2023.01.10
1、新增项目模块和project表
2、新增接口/runapi/batchSync,通过接口同步推送数据
3、优化功能和界面

jfinal-runapi-v2.0.0 2022.12.18
1、新增登录功能
2、新增分享功能
3、新增数据源功能
4、v2.0,通过数据源功能就可以整合到已有的jfinal项目和springboot项目,实现独立运行部署

jfinal-runapi-v1.1.1 2022.12.15
1、修改BaseRunapi接口描述字段为:description
2、修复js方法:loadObjectPara处理字段值为null的情况

jfinal-runapi-v1.1.0 2022.11.11
1、新增文档导出功能
2、新增复制代码功能
3、修复表格删除按钮bug

jfinal-runapi-v1.0.0 2022.11.5


评论区(0)

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