mirror of https://gitee.com/shuzhikai/apiflow.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
151fdcf662
|
3 years ago | |
|---|---|---|
| public | 3 years ago | |
| src | 3 years ago | |
| tests/e2e | 4 years ago | |
| .browserslistrc | 4 years ago | |
| .eslintrc.js | 4 years ago | |
| .gitignore | 4 years ago | |
| README.md | 4 years ago | |
| babel.config.js | 4 years ago | |
| cypress.json | 4 years ago | |
| local-update.yml | 3 years ago | |
| package.json | 3 years ago | |
| tsconfig.json | 4 years ago | |
| vue.config.js | 3 years ago | |
| yarn.lock | 3 years ago | |
README.md
预览
常用
在线体验(由于浏览器限制，完整版功能需要下载客户端)
客户端GitHub地址 | 服务端GitHub地址 | 客户端Gitee地址 | 服务端Gitee地址
QQ交流群
977506603 欢迎加入
主要功能
团队协作
- 登录，注册，修改个人信息，修改密码
- 管理员细粒度权限控制，控制到单个前端路由，单个后端接口
- 接口管理基础权限，管理员、读写权限、只读权限、
- 批量用户导入，用户禁用，用户权限更改
- 自定义权限
接口调试
- 常见GET、POST、PUT、DELETE、HEAD、OPTIONS等请求方式
- 支持restful风格接口调试
- 支持查询字符串，body传参
- 支持form-data、x-www-form-urlencoded、json、xml、text、二进制等
- 支持自定义请求头
- 支持变量
- 支持优雅的json展示，支持多种MIME类型返回数据展示
- 前置钩子(pre-request)
- websocket
左侧导航菜单
- 支持任意层级嵌套，无接口数量限制
- 支持拖拽
- 支持批量拖拽
- 支持鼠标右键。新增、模板新增、重命名、删除等
- 支持快捷键。eg: F2修改文件名、Ctrl + 鼠标左键批量选中、Ctrl + 鼠标移入显示详情
- 支持批量删除
- 支持接口复制
- 支持文件夹复制
- 支持导航菜单随Tab导航同步展开
- 支持导航菜单排序
- 支持根据URL搜索、文档名称搜索
- 支持高级筛选，操作人员、文档日期范围、最近N条数据、文档标签
- 支持宽度调整
左侧导航栏快捷操作
- 新建文件
- 新建文件夹
- 导出文档
- 生成在线链接
- 刷新导航栏数据
- 预览文档
- 导入文档
- 历史记录
- 项目配置
- 回收站
- 自定义快捷栏组成
顶部tabs切换
- 支持拖拽
- 支持右键菜单
- 支持显示修改状态
接口录入
- 支持修改缓存，防止数据未保存丢失
- 支持按模板新建单个接口，选择模板新增接口
- 支持按模板批量新增多个接口
- 支持自定义变量
- 支持cookie自动携带
- 支持restful风格路径参数
- 支持查询字符串(?id=3&name=lee)
- 支持丰富的body传参类型。form-data、x-www-form-urlencoded、json、xml等
- 支持录入规则配置，允许用户根据请求方法限制传参类型(eg: 限制post请求只支持json类型传参)
- 支持任意多个返回参数展示(eg: 成功返回，失败返回)
- 支持自定义请求头
- 支持富文本备注信息填写
- 支持参数模板，常见参数保存为模板方便下次引用
- 支持json格式参数导入，导入参数自动带出备注信息
- 支持智能补全，参数录入后，会自动根据历史记录补全参数类型、备注、值、是否必填等信息
- 支持接口标签，用户可自定义接口标签方便管理
录入审计
- 从新增项目开始，所有操作(接口增删改查、新增人员、拷贝、移动、导入导出等)全部纳入审计
- 丰富的历史纪录筛查功能，直观的历史纪录展示功能
- 完整的操作信息纪录(谁在什么时间操作了什么)
- 历史纪录保存无数量限制
- 删除数据还原
- 接口修改回退任意版本
- 接口任意版本数据对比
快捷键
- 常见操作快捷键(导出文档、导入文档、生成在线链接)
- 常见行为快捷键(新增接口、保存接口)
- 自定义快捷键
Mock数据
- 完整Mockjs语法
- 快速Mock，真实服务端环境下调用，无需任何配置
- 自定义枚举Mock值
第三方导入
- 支持追加导入和覆盖方式导入
- 支持导入到当前项目任意文件夹内
- 项目自身文档导入
- postman格式导入
- swagger/openapi格式导入
- yapi格式导入
- rap2格式导入
- Eolinker格式导入
- DOClever格式导入
- Curl格式导入
文档导出
- 支持HTML格式导出，支持全量导出，支持任意数量导出 快乐摸鱼离线文档.html
- 支持JSON格式导出，支持全量导出，支持任意数量导出 快乐摸鱼离线数据.json
- 项目内自由导出，支持将当前项目(任意多个文档)导出到任意项目任意位置
- 支持PDF格式导出
部署&二次开发
环境要求
- nodejs(10+)
- mongodb(2.6+)
- nginx(任意web服务器，可选)
主要技术栈
- Vue
- Electron
- Egg.js
- ElementUI
- MongoDB
License
MIT