Java-自动生成带页面可调试的接口文档
介绍:一款java接口文档自动生成的插件,包含了根据接口注释或注解自动生成接口文档,可网页打开。
特点:一款无任何代码侵入的生成方式,10秒钟集成
1.支持读取java默认的行注释和文档注释
2.兼容swagger注释
3.推荐使用内部@ApidocComment注解,属性标注比较全面,默认值也比较友好
4.支持生成接口mock数据
5.支持使用自定义请求参数和请求头真实调用接口测试
6.支持统一添加返回数据外包装
功能列表:
首页-文档介绍
首页-请求环境配置(可配置多个地址,用于模拟请求)
首页-返回参数外包装配置(可手动配置项目对返回数据的包装结构)
首页-同步文档(将文档向指定地址发送同步,目标地址成功接收后会更新自己的文档)
这里是列表文本
这里是列表文本
菜单栏-搜索(可根据接口名称和接口请求路径模糊搜索接口,支持拼音搜索)
菜单栏-控制器列表(controller)
菜单栏-接口列表
菜单栏-删除接口
菜单栏-导入接口(将其他接口文档导入导本地)
接口详情-修改接口基本信息
接口详情-导出接口结构
这里是列表文本
接口详情-选择环境
接口详情-接口返回mock(自动生成假数据)
接口详情-接口真实请求
接口详情-选择参数填写方式(json或form)
接口详情-修改接口入参(字段隐藏,字段必填,字段类型。。。)
接口详情-修改接口返回值
接口详情-导入导出接口入参和返回
包含权限和用户模块,可以自定义用户和访问权限
软件架构
使用springboot-2.1.3核心架构
页面呈现使用VUE
数据存取采用本地json文件
安装说明
下载jar包:https://download.csdn.net/download/qq_37527048/12918433
maven导入项目中,添加配置文件
cn.easyutil
easyapi/artifactId>
使用说明:添加如下配置后,启动项目。
浏览器输入 http://localhost:项目端口/apidoc.html 即可以访问页面
package cn.easyutil.easyapi.logic;
import cn.easyutil.easyapi.conf