开发必备工具,快速生成接口文档、调用示例、mock配置

article/2025/3/6 21:50:36

前言

开发中,接口文档很重要,特别是现在web开发都开始前后端分离了,更加需要一个好的接口文档。

那要怎么快速的出接口文档、调用示例、mock呢?如果太麻烦,很多人就不愿意去写了。

今天给大家介绍一个非常方便的工具,易文档 https://easydoc.top

易文档是一个专业的接口管理平台,他可以轻松的写出专业漂亮的api文档,更重要的是可以一键生成接口文档、调用示例、mock配置,一举三成,轻松愉快。

先睹为快,在线看 预览效果

如何一键生成

开发完接口,我们通常都需要进行下接口测试,以便确定接口是ok的

易文档提供在线接口测试功能,关键是测试后,易文档可以根据你的请求和响应参数,一键生成接口文档,然后根据文档又可以一键生成mock配置,还可以把整个测试过程保存为一个调用示例。

这样接口测试完了,你的文档、示例、mock也都有了。

动图演示一键生成文档

一键生成文档

动图演示生成调用示例

添加调用示例,可以让其他人更好的理解怎么调用接口。

你可以在接口测试后,把整个请求和响应参数存为一个调用示例

调用示例还可以方便测试人员保存各种情况的测试结果喔,比如手机号登录、验证码登录等不同调用,不同临界值都可以保存为一个调用示例

生成调用示例

一键生成mock配置

服务端接口还没开发好,怎么办?只需要把接口文档写好,就可以一键生成mock配置啦,客户端就可以进行开发了,看下图

根据文档一键生成mock配置

 

最后文档效果

下面是最后的文档预览效果,其中绿色的爬虫是表示调用示例,瓶子表示mock,在线看 预览效果

文档预览效果


http://chatgpt.dhexx.cn/article/IVSEICes.shtml

相关文章

layui官方文档保存

前言 在layui官网看到了它官网即将在2021.10.13停运,所以我决定将它的文档进行复制保存下来,以便于可以进行查阅 (不清楚会不会依然有官方文档,如果还有就当参考吧) 目录页 文章目录 前言目录页基础说明开始使用开始使…

接口文档编写工具

现在越来越流行前后端分离开发,使用ajax交互。所以api接口文档就变的十分有意义了,目前市场有哪些比较优秀的接口文档管理工具呢? 目录 1.MinDoc2.eoLinker3.apizza4.RAML5.其他工具1.Swagger2.Showdoc3.apidoc4.RAP5.APIJSON6.易文档 1.Min…

如何撰写需求文档

永远考虑那个拥有更强写作能力的人工欲善其事,必先利其器 markdown思维导图流程图 换位思考这个需求,「不做」闭环写作套路 铺垫下定义逻辑清晰说人话视角版本延续性 结语 Reading makes a full man, conference a ready man, and writing an exact man. 本文节选自《Springboo…

一份完整齐全的技术方案文档

2022年-[归一计划三期-用户中心三期第二阶段]技术方案 部门:基础架构部 时间:2022.02.25 1、背景 描述技术方案的背景 由于历史原因,旧服务存在很多代码不规范、冗余度高、扩展性差等问题,为了解决此类问题,以及将功…

易文档(yidocs),更简单的markdown静态文档生成模板

基本简介 yidocs(易文档),是在 vuepress 主题 vuepress-theme-hope 基础上,进一步简化使用的文档模板。 大部分配置和参数都有默认值,使用 yidocs(易文档)的用户,只需要填写必要的…

idea java配色方案_IDEA 主题配色方案+字体

IntelliJ IDEA被认为是当前Java开发效率最快的IDE工具。它整合了开发过程中实用的众多功能,几乎可以不用鼠标可以方便的完成你要做的任何事情,最大程度的加快开发的速度。 关于IDEA 主题配色方案 主题配色方案放置位置(Win7为例): C:\Users\A…

蓝绿色配色_蓝绿色部署

蓝绿色配色 传统上,我们通过替换当前版本来部署新版本。 旧版本停止了,新版本被替换了。 这种方法的问题是从旧版本停止到新版本完全运行之间的停机时间。 无论您尝试执行此过程的速度如何,都会有一些停机时间。 那可能只有一毫秒&#xff0c…

践行绿色发展理念,产业园区绿色转型发展之五大路径

近年来,我国产业园区蓬勃发展,成为区域经济的重要载体。但在这个发展过程中,一些产业园区面临着较大的能源资源及环境排放压力,影响到了园区的可持续发展。随着“碳中和”发展目标的提出,产业园区将走入绿色转型发展的…

色彩的基本配色方案

色彩是我们观察事物的第一认知,是最能触动我们感官的视觉元素。色彩可以激发我们的联想,刺激我们的情绪。在设计中,色彩的合理运用一直是个很重要的课题,在这里我总结了一些色彩部分的常识分享给大家。 一、色环 原色由红黄蓝组成…

IDEA自定义配色方案

整体颜色无主题,都是自己调整的,突然看上去色系比较多,但是多看一会就能清晰分辨出各个颜色的用途,整体配色属于鲜亮方案,元素颜色对比比较明显,个人感觉半灰阶看着不舒服。 Java文件配色方案 Mapper.xml配…

2023华数杯B题不透明制品最优配色方案设计(思路+Matlab代码+论文)

目录 思路 Matlab代码 论文框架 思路 问题1:计算着色剂在不同波长下K/S与浓度的关系 首先,问题1要求我们计算附件2中三种着色剂在不同波长下K/S与浓度的关系,并将关系式与拟合系数填写在表格中。为了完成这一步,我们需要以下步骤: 了解光学模型:阅读文献【1】《计…

前端常用的超赞的配色网站

1.中国风配色 zhongguose.com 超美的中国风配色,网站号称收集了最全的中国色,还有中英文互译,非常贴心,五星好评。 2.uiGradients uigradients.com 做渐变配色专用的网站,色值什么的非常全。 3.Adobe Color CC co…

2023年华数杯B题不透明制品最优配色方案设计(思路+代码+论文,已第三次更新)

已第三次更新,今天下午应该能把三道题都更新完毕.晚上开始写论文,专栏中有思路和代码. 4号18:00前订阅专栏,论文无需二次收费 目录 问题二+代码 问题三+代码 问题四+代码 问题1+代码 要求计算着色剂K/S与浓度的关系,然后通过拟合得到函数关系式和拟合系数。首先,我们需要…

IAR配色方案及配置方法

前言 从事嵌入式开发基本都要和 IAR 这款集成IDE打交道,其默认都是浅色主题,且自定义的一些关键字没有高亮的功能,今天给大家分享一个暗色系的配色方案,并且可以高亮自定义的关键字. 修改IAR配色方案的方法 设置编辑器的配色 T…

论文配色方案

方案1(复古): 系列色——十六进制颜色码: 0780cf - 765005 - fa6d1d - 0e2c82 - b6b51f - da1f18 - 701866 - f47a75 - 009db2 - 024b51 - 0780cf - 765005 系列色——RGB颜色值: (7,128,207&#xff09…

消除WSL中ls Windows文件夹时背光配色的方法

消除WSL中ls Windows文件夹时背光配色的方法 产生原因 首先,Linux中ls命令是自带配色的,对于某些文件夹是绿色背景色块,其实是一种权限提示,即777权限。绿色表示不安全,当其他人的权限高于所有者或者所属组时就会变成…

科研绘图-配色指南

好的图形展示方式能够简明扼要地表达数据,而好的配色一方面能够突出数据的重点,另一方面能够使所有的数据和谐共存。好的配色是图的二次进化,能够赋予图片“生命”。 1,日常生活中使用的颜色 日常生活中,我们经常提到各…

【matlab】绘制云图 + 修改配色方案 + 保存配色方案

一、绘制云图 假设 x、y 为坐标向量,f 为各个坐标点所对应的函数值 的向量 1、需要根据 x、y 的范围进行划分,可以理解为建立坐标系或比例尺 X1和Y1 X1 linspace(min(x),max(x),100); %将坐标均分成100份 Y1 linspace(min(y),max(y),100);…