apidoc接口文档编辑系统,支持可视化编辑、接口模拟响应、动态预览及调试、导出PDF文档等特性。

• 可视化编辑:支持表单界面编辑接口,不必手动编辑swagger.json
• 接口模拟响应:支持js动态生成模拟响应,实现前后端分离开发(后台还没有@Controller、@ApiOperation等)
• 支持测试案例:支持简单接口的测试案例,使用json配置请求参数,使用assert、expect的js方法验证结果
• 动态预览及调试:接口修改后预览页面实时刷新,开启模拟时可以直接调试调用
• 导出PDF文档:预览页面有"离线文档MD"菜单,安装writage插件可以手动导出PDF文档(有书签)
• 本地调试:配合nginx可以调试本地接口,可以导入本地swagger并生成接口文档

1. 创建数据库:apidoc(字符集utf8mb4或utf8),导入脚本:api-web/db/sosoapi-1.0.0.sql
2. 修改配置:api-web项目里的 filter-dev-master.properties、mail-cfg.properties
3. 构建项目:mvn install,mvn compile resources:resources war:exploded -f api-web/pom.xml
4. 部署到tomcat:<Context docBase="apidoc/api-web/target/apidoc" path="/apidoc" reloadable="true"/>
5. 访问:http://localhost:8080/apidoc/,登录:admin@qq.com,密码:123456,apidoc
6. 线上部署:sh deploy.sh,mvn compile resources:resources war:exploded -P env-aliyun-master -f api-web/pom.xml

1. 接口协议优先顺序:接口Inter > 文档ApiDoc > 网址Url,模拟时会忽略ApiDoc已有的scheme、host、basePath
2. 支持接口模拟:可以给请求参数指定响应,也可以js代码动态生成响应,演示,模拟,模拟失败时响应schema结构和注释信息
3. 支持生成knife4j-front需要的group.json文件,演示,模拟
4. 安装writage插件可保存为PDF文档,操作见文档,示例:knife4j-front/sosoapi_demo.pdf
5. 日志切换至logback,支持输出日志到logserver
6. 支持测试案例:可以给接口添加多个测试案例,支持批量执行测试案例和切换mock功能

演示地址: apidoc knife4j

mock

• 数据库字符集:mysql高版本支持utf8mb4则优先使用,低版本使用utf8也行。

spring-mybatis.xml,连接池使用了druid,因为原来的bonecp在低版本mysql时报错。

• 发送邮件失败:

java.lang.NoSuchMethodError: com.sun.mail.util.TraceInputStream,org.apache.commons.mail.EmailException: Sending the email to the following server failed。解决办法:base-mail/pom.xml,修改commons-email为1.5版本。

• 手机移动页面优化:

前端页面在手机移动端的显示效果不太好,旋转屏幕后勉强可以操作。

• QQ群:957806743,钉钉群:21975907
• Email:admin@xlongwei.com