接口文档生成工具ApiPost挺好用

2023-11-07

作为一名程序员我深知一款好用的软件工具对工作效率的提升意味着什么,相信不少程序员还在依靠老外们做的软件处理手头工作,曾经我也是其中一员,不过现在我已经开始迷上了国产软件, 国外的自然后他的优势,但国产软件工具也吸引了不少程序员开始尝试,虽然他还有这样和那样的不足,但是做为一名土生土长的中国程序员,我还是相信自家造的东西的,举个栗子就好比最近在用的Apipost就是一个值得推荐的好工具。

或许我们不少做编程的朋友可能还在使用postman、swagger、mock等工具吧,你可曾知道这类软件在国内已经悄悄的发展起来了,而且多是集成了多种软件功能,不能满足多种应用场景,还提高了工作效率,其实这类软件不止Apipost,但为什么我要挑它来讲呢?重要是因为它不仅可以模拟发送get、post、delete、put请求,还可以导出文档,支持团队协作。

要知道对于postman等国外软件来说,我们是有使用成本的,不仅工位相对较贵,而且对于国内程序员来说有些费劲,尤其是针对英语不太好的朋友们,是不是的就得用用有道词典吧?ApiPost自己人做的软件更适合符合国内程序员喜好。下边给大家分享两个我认为很好用的功能。

1、一键生成文档

我们在“2分钟玩转APIPOST”一讲中,简单介绍了如何生成并分享接口文档:

点击分享文档
  在这里插入图片描述

复制并打开文档地址就可以看到了完整的接口文档。
  在这里插入图片描述

本节课主要是讲解一些需要注意的事项。

请求参数的描述填写

对于header、query以及form-data和urlencode的body参数,我们在如下地方填写参数描述:
  在这里插入图片描述

如图中所示,对于一个填写过的参数,我们可以在新建接口可以通过点击参数描述后面的♦️方块标志快速导入描述,不用重复打字。

对于raw类型的body参数,我们可以通过点击“提取字段和描述”来针对参数进行描述的填写:
  在这里插入图片描述

对于已经填写过的参数,APIPOST会自动匹配描述,不用重复填写。

响应参数的描述填写

很多新手困惑为什么APIPOST分享的文档没有成功响应示例和错误响应示例,那是因为APIPOST不会把发送后的实时响应的数据作为响应示例。
  在这里插入图片描述

您需要手动的将实时响应结果导入或者复制到对应的成功响应示例和错误响应示例。

字段描述的填写跟raw类型的body参数,我们可以通过点击“提取字段和描述”来针对参数进行描述的填写。

同样,对于已经填写过的参数,APIPOST会自动匹配描述,不用重复填写。

2、

参数描述库

填写参数描述是我们最烦恼的一件事情,尤其对于很多接口来说,往往具有大量相同名称、相同意义的参数,假如每次都需要手动录入,将会是一件非常耗时、低效的事情。

我们可以通过参数描述库解决这个问题。

在这里插入图片描述
  在这里插入图片描述

参数描述库的使用

通过自定义参数描述库,我们可以将本项目用到的大量参数进行预注释:
  

我们也可以通过导入参数描述功能,将数据库定义的字段注释快速导入到APIPOST的参数描述库中。

快速导入参数描述

这样我们在填写参数描述的时候,针对已定义的参数,我们可以直接快速导入参数描述:
  在这里插入图片描述

看看,多么好的软件呀,刚开始用的时候确实让我眼前一亮,除此之外Apipost还有很多好玩的功能期待着你去发现,那怎么下载安装呢?
在这里插入图片描述
  在这里插入图片描述
当然也可以直接输入官网网址:https://www.apipost.cn/?csdn/lsp

最后想说的是无论是postman还是Apipost都有人喜欢,正如我们经常说的那句话,萝卜白菜各有所爱,不过就个人经验来看,Apipost必将是未来趋势,自己家的软件用起来更安全,国产的工具操作起来也一定更顺手!

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

接口文档生成工具ApiPost挺好用 的相关文章

随机推荐

  • socket绑定指定网卡发包

    socket绑定指定网卡发包 SO BINDTODEVICE 网络编程中有时明明用eth0的地址来bind一个udp套接口 可是发出去的包却是从eht1走的 在网上找到这么一段话解释该问题 在多 IP 网卡主机上 UDP 包 协议会自动根据
  • java使用ssh连接linux服务器执行命令

    可以使用JSch框架来连接SSH服务器并执行命令 JSch是SSH2的一个纯Java实现 它允许你连接到一个sshd服务器 使用端口转发 X11转发 文件传输等等 你可以在pom xml文件中添加以下依赖来引入JSch框架
  • vue3 使用QrCode生成二维码

    官网地址 QrCode官网 第一步 安装 npm install save qrcode vue 第二步 引入并注册 import QrcodeVue from qrcode vue export default defineCompone
  • 层次分析法(AHP)详解+完整代码

    层次分析法 AHP 1 算法简述与原理分析 层次分析法是一种主观赋值评价方法也是一个多指标综合评价算法 常用于综合评价类模型 层次分析法将与决策有关的元素分解成目标 准则 方案等多个层次 并在此基础上进行定性和定量分析 是一种简单 实用的算
  • 移动端修改下拉框背景

    移动端设置 下拉框背景 找到下拉框控件 添加初始化后事件 setTimeout function var dateEditor document getElementById P ORGNAME firstChild dateEditor
  • CentOS 7中安装Nginx 并设置自启动

    在CentOS 7中安装Nginx 当使用以下命令安装Nginx时 发现无法安装成功 yum install y nginx 如果出现没有可用软件包 需要做一点处理 安装Nginx源 执行以下命令 rpm ivh http nginx or
  • git学习(一)设置、修改用户名密码

    设置用户名 密码 点击 Git 选项 然后点击右侧的全局 最后输入用户名和邮箱即可 如下图所示 注 这里的用户名和邮箱 将作为以后提交数据到Git服务端的作者信息 请一定要设置 默认情况下 Git 客户端每次与服务器交互 都需要输入密码 但
  • C++中void和void*指针的含义

    转载 http blog chinaunix net uid 22197900 id 359211 html 转载 http www jb51 net article 36570 htm 对以上两篇文章 我进行了重新地汇总整理 转载请注明
  • 电脑系统提示vcomp100.dll文件缺失该怎么办?提示vcomp100.dll丢失问题怎么解决?

    vcomp100 dll实际上是VC 运行库中的一个动态链接库文件 版本是VC 2010 VC2010 Microsoft Visual C 2010 Redistributable Package 安装 Visual C vc2010 库
  • SSH 免密码登录ssh-keygen&ssh-copy-id&sshpass命令详解

    SSH 免密码登录ssh keygen ssh copy id sshpass命令详解 ssh keygen命令详解 功能 生成ssh密钥验证所需要的私钥与公钥文件 参数 t 指定密钥类型 f 指定生成私钥文件名 P 提供 旧 密语 例子
  • 深度学习笔记 4 过拟合+欠拟合+解决方案

    目录 1 偏差与方差 2 产生原因 3 解决欠拟合 高偏差 的方法 3 1 模型复杂化 3 2 增加更多的特征 3 3 调整参数和超参数 3 4 增加训练数据 效果不明显 3 5 降低正则化约束 4 解决过拟合 高方差 的方法 4 1 增加
  • 实例:vmem_disk设备驱动的block_device_operations(3)

    vmem disk提供block device operations结构体中的getgeo 成员函数 如下给出了vmem disk设备驱动的block device operations结构体定义及其成员函数的实现 static int v
  • openwrt中br-lan,eth0,eth0.1,eth0.2 已经 实际网口wan,lan对应的配置

    openwrt的接口真是多 老高一下子都看晕了 不过仔细理一理 还是能够分辨的 首先盗openwrt wiki中的一张图 这张图对理解这些接口很重要 I 网络配置 有线网配置 openwrt的有线网络配置文件位于 etc config ne
  • mybatis5-分页插件.md

    一 jar包 逆向工程不支持分页 PageHelper 底层使用拦截器 二 配置拦截器
  • 小程序大屏适配指南

    小程序大屏适配指南 概述 为保证用户在PC端使用小程序也有流畅友好的体验 本指引将提供一系列大屏适配相关建议 以供参考 1 为什么要做适配 由于用户可在PC端使用小程序 且有可能在不同尺寸视图下进行切换 为了保证小程序在不同尺寸屏幕下的体验
  • ATF(TF-A) fvp_r 平台威胁模型-安全检测与评估

    安全之安全 security 博客目录导读 ATF TF A 威胁模型汇总 目录 一 简介 二 评估目标 1 只支持BL1 2 EL3是不支持的 并且是完全安全的 3 用MPU代替MMU 4 不支持AArch32 5 威胁评估 一 简介 本
  • 什么是模块化?模块化的好处?

    什么是模块化 模块化就是将js文件按照功能分离 根据需求引入不同的文件中 源于服务器端 模块化好处 1 解耦 对业务进行模块化拆分后 为了使各业务模块间解耦 因此各个都是独立的模块 它们之间是没有依赖关系 2 复用 每个模块负责的功能不同
  • Element UI更改下拉菜单el-dropdown-menu样式

    Element UI更改下拉菜单el dropdown menu样式 源代码
  • [网络安全自学篇] 八十一.WHUCTF之WEB类解题思路WP(文件上传漏洞、冰蝎蚁剑、反序列化phar)

    这是作者网络安全自学教程系列 主要是关于安全工具和实践操作的在线笔记 特分享出来与博友们学习 希望您喜欢 一起进步 前文分享了WHUCTF部分题目 包括代码审计 文件包含 过滤绕过 SQL注入 这篇文章将讲解Easy unserialize
  • 接口文档生成工具ApiPost挺好用

    作为一名程序员我深知一款好用的软件工具对工作效率的提升意味着什么 相信不少程序员还在依靠老外们做的软件处理手头工作 曾经我也是其中一员 不过现在我已经开始迷上了国产软件 国外的自然后他的优势 但国产软件工具也吸引了不少程序员开始尝试 虽然他