百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分类 > 正文

开源推荐:基于vue和electron的接口文档管理工具

ztj100 2024-12-27 17:54 17 浏览 0 评论

简介

今天给大家介绍的是一款开源的接口文档管理工具,目的是为了提高前后端联调效率。同类的产品有很多,大部分都非常的优秀,但每款产品或多或少都缺少一些完整的功能,我们学习和使用了常见的几款接口文档管理工具,在此基础开发出一款更为高效的接口工具。

下面这张图展示了一个接口管理工具所具备的主要功能模块。更为详细的内容可以参考思维导图。



团队&权限管理


角色名称

功能

只读

仅项目预览

读写

项目预览和编辑

管理员

允许拉人和读写

创建者

拥有项目的完整权限


基础的角色功能能够满足大部分的业务场景,我们也提供更加细粒度的权限控制功能,你甚至可以控制到每一个接口 权限参考。

接口录入

接口录入是整个工具中非常核心的功能,我们浏览了常见开源产品中的大量issue,解决了许多其他产品没有解决的问题。

导航栏任意层级嵌套


丰富的搜索和过滤

  • 接口名称
  • 接口url
  • 创建人员
  • 时间
  • 其他

接口录入辅助功能

  • 导入json
  • 使用模板
  • 自动补全参数备注
  • 录入提示
  • 应用模拟请求返回值为参数值
  • 其他

上图将常用参数保存为模板,下次录入的时候可以选择相应的模板

上图通过导入json方式录入参数,如果字段之前录入过那么会自动补全备注信息

上图将模拟请求的返回值直接应用为返回参数

任意多个返回值

一般情况下接口的返回值可能不止一种,可以根据自身业务录入任意多个返回值。

  1. 接口展示页面
  1. 接口录入页面

模拟请求

你可以在不借助其他工具或者插件的情况下,直接通过接口工具发送请求到服务器(类似postman)。

文档辅助

历史记录

对于文档的任何操作系统都会进行详细的记录。同时系统还会提供非常方便的查询过滤功能,你可以快速查询到相关的操作记录。


文档导出

我们目前提供三种方式的文档导出

  1. 静态HTML文件 快乐摸鱼.html
  2. 系统本身的JSON文档,可以用于备份文档或者处理为第三方工具适配的数据类型快乐摸鱼.json
  3. 导出到其他项目,你可以选择将某个项目的部分接口导出到其他项目

你可以选择任意多的文档进行导出,或者将整项目一起导出

文档导入

导入对于迁移时非常重要的功能,我们想办法尽可能多的支持不同类型的接口导入。由于项目是开源的,我们提供了相关的导入接口,必要时用户可以通过直接调用接口的方式来导入第三方文档,当然我们希望未来有一套合理的插件机制来处理这个问题。

导入的文档会自动进行备注信息的匹配

在线分享

在对接第三方的时候,有时第三方用户并不愿意注册账号来使用工具。你可以通过生成在线链接来分享你的接口,这样用户就不必注册账号就能预览接口。在线链接,密码 111111

与导出的静态HTML不同,在线分享的接口会保持实时同步

模拟请求

后端开发人员一般会使用一些工具来发送请求进行联调,接口工具本身集成了发送请求的功能。


接口预览

我们将接口录入和接口预览分成了两个完全不同的模块,对于录入人员来说可以高效的完成接口录入,对于预览人员来说可以快速定位接口并且拥有非常直观的展示形式。


欢迎点赞+转发+关注!大家的支持是我分享最大的动力!!!

相关推荐

Sublime Text 4 稳定版 Build 4113 发布

IT之家7月18日消息知名编辑器SublimeText4近日发布了Build4113版本,是SublimeText4的第二个稳定版。IT之家了解到,SublimeTe...

【小白课程】openKylin便签贴的设计与实现

openKylin便签贴作为侧边栏的一个小插件,提供便捷的文本记录和灵活的页面展示。openKylin便签贴分为两个部分:便签列表...

“告别 Neovim!为什么我投奔了刚开源的 Zed 编辑器?”

...

壹啦罐罐 Android 手机里的 Xposed 都装了啥

这是少数派推出的系列专题,叫做「我的手机里都装了啥」。这个系列将邀请到不同的玩家,从他们各自的角度介绍手机中最爱的或是日常使用最频繁的App。文章将以「每周一篇」的频率更新,内容范围会包括iOS、...

电气自动化专业词汇中英文对照表(电气自动化专业英语单词)

专业词汇中英文对照表...

Python界面设计Tkinter模块的核心组件

我们使用一个模块,我们要熟悉这个模块的主要元件。如我们设计一个窗口,我们可以用Tk()来完成创建;一些交互元素,按钮、标签、编辑框用到控件;怎么去布局你的界面,我们可以用到pack()、grid()...

以色列发现“死海古卷”新残片(死海古卷是真的吗)

编译|陈家琦据艺术新闻网(artnews.com)报道,3月16日,以色列考古学家发现了死海古卷(DeadSeaScrolls)新残片。新出土的羊皮纸残片中包括以希腊文书写的《十二先知书》段落,这...

鸿蒙Next仓颉语言开发实战教程:订单列表

大家上午好,最近不断有友友反馈仓颉语言和ArkTs很像,所以要注意不要混淆。今天要分享的是仓颉语言开发商城应用的订单列表页。首先来分析一下这个页面,它分为三大部分,分别是导航栏、订单类型和订单列表部分...

哪些模块可以用在 Xposed for Lollipop 上?Xposed 模块兼容性解答

虽然已经有了XposedforLollipop的安装教程,但由于其还处在alpha阶段,一些Xposed模块能不能依赖其正常工作还未可知。为了解决大家对于模块兼容性的疑惑,笔者尽可能多...

利用 Fluid 自制 Mac 版 Overcast 应用

我喜爱收听播客,健身、上/下班途中,工作中,甚至是忙着做家务时。大多数情况下我会用MarcoArment开发的Overcast(Freemium)在iPhone上收听,这是我目前最喜爱的Po...

Avalonia日志组件实现与优化指南(ar日志表扣)

...

浅色Al云食堂APP代码(三)(手机云食堂)

以下是进一步优化完善后的浅色AI云食堂APP完整代码,新增了数据可视化、用户反馈、智能推荐等功能,并优化了代码结构和性能。项目结构...

实战PyQt5: 121-使用QImage实现一个看图应用

QImage简介QImage类提供了独立于硬件的图像表示形式,该图像表示形式可以直接访问像素数据,并且可以用作绘制设备。QImage是QPaintDevice子类,因此可以使用QPainter直接在图...

滚动条隐藏及美化(滚动条隐藏但是可以滚动)

1、滚动条隐藏背景/场景:在移动端,滑动的时候,会显示默认滚动条,如图1://隐藏代码:/*隐藏滚轮*/.ul-scrool-box::-webkit-scrollbar,.ul-scrool...

浅色AI云食堂APP完整代码(二)(ai 食堂)

以下是整合后的浅色AI云食堂APP完整代码,包含后端核心功能、前端界面以及优化增强功能。项目采用Django框架开发,支持库存管理、订单处理、财务管理等核心功能,并包含库存预警、数据导出、权限管理等增...

取消回复欢迎 发表评论: