Giter Site home page Giter Site logo

trueleaf / moyu Goto Github PK

View Code? Open in Web Editor NEW
444.0 12.0 74.0 11.58 MB

基于 Vue 和 Electron 的在线协同api接口管理工具。接口文档管理工具、接口工具、接口文档、api文档、api工具、快乐摸鱼

Home Page: https://online.jobtool.cn

License: MIT License

JavaScript 3.04% HTML 0.07% Vue 52.20% SCSS 1.28% TypeScript 43.10% CSS 0.31%
api restful electron api-manager api-management api-test vue-electron

moyu's Introduction

logo

摸鱼(客户端Typescript版本)

一款基于 Vue 和 Electron 的接口文档管理工具

客户端下载 | 完整文档 | 在线体验

                 

预览

输入图片说明

输入图片说明

输入图片说明

常用

产品介绍

使用教程

完整文档

在线体验(由于浏览器限制,完整版功能需要下载客户端)

客户端下载

客户端 GitHub 地址 | 服务端 GitHub 地址 | 客户端 Gitee 地址 | 服务端 Gitee 地址

客户端部署

  • Node.js 14.x 或 以上
git clone https://github.com/trueleaf/moyu   //国内建议:git clone https://gitee.com/shuzhikai/apiflow
cd moyu
npm install  //安装依赖,推荐使用yarn
npm run electron:build   //打包并且生成相应系统安装包(Mac、Linux、Windows)

默认情况下你不需要部署服务端就能体验客户端完整功能,我们默认将打包后程序服务端地址指向了体验服务器。如果你希望程序访问自己的服务器,可以访问 完整部署文档

主要技术栈

  • Vue
  • Electron
  • Egg.js
  • ElementUI
  • MongoDB

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 格式导出

License

MIT

moyu's People

Contributors

shuxiaokai3 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

moyu's Issues

LDAP

这个不支持LDAP吗

Oauth 2.0

还是想要这个Oauth的功能呀

前端安装依赖冲突

安装时报错,报错信息如下:

npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR!
npm ERR! While resolving: [email protected]
npm ERR! Found: [email protected]
npm ERR! node_modules/eslint
npm ERR!   dev eslint@"^7.29.0" from the root project
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer eslint@">= 1.6.0 < 7.0.0" from @vue/[email protected]
npm ERR! node_modules/@vue/cli-plugin-eslint
npm ERR!   dev @vue/cli-plugin-eslint@"~4.5.0" from the root project
npm ERR!
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.

使用npm install --force安装成功,希望解决一下。

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.