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

作为一名程序员我深知一款好用的软件工具对工作效率的提升意味着什么，相信不少程序员还在依靠老外们做的软件处理手头工作，曾经我也是其中一员，不过现在我已经开始迷上了国产软件，国外的自然后他的优势，但国产软件工具也吸引了不少程序员开始尝试，虽然他还有这样和那样的不足，但是做为一名土生土长的中国程序员，我还是相信自家造的东西的，举个栗子就好比最近在用的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必将是未来趋势，自己家的软件用起来更安全，国产的工具操作起来也一定更顺手!

接口文档生成工具ApiPost挺好用相关推荐

java接口文档生成工具_【分享】接口文档生成工具apipost
一.为什么要写接口文档? 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发 ...
接口文档生成工具apipost
一.为什么要写接口文档? 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 2.项目开发过程中前后端工程师有一个统一的文件进行沟通交流 ...
java接口文档生成工具_接口文档生成
一.为什么要写接口文档? 1.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 2.项目开发过程中前后端工程师有一个统一的文件进行沟通 ...
spring-boot 一款无侵入型，轻量级的接口文档生成工具apiggs
spring-boot 一款无侵入型,轻量级的接口文档生成工具apiggs 名字叫:apiggs 使用只需两步,先把插件代码引入pom文件,然后编译打包即可之后项目的target目录下,就会多出一个 ...
基于文档注释接口文档生成工具(代码0侵入附源码)
本文主要分享一个基于个人兴趣,旨在提高工作效率,开发了一个基于文档注释,接口文档生成工具,欢迎大佬指点. 源码以及使用demo地址 :传送门 1.前置介绍 1.1前世现在大多数项目都走向了前后端分离 ...
扔掉Swagger，试试这款功能强大，零注解侵入的API接口文档生成工具！
欢迎关注方志朋的博客,回复"666"获面试宝典介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-d ...
java 接口文档工具_一款Java基于注释的接口文档生成工具
一. 痛点你还在手动维护接口文档嘛,花一个下午不停的复制粘贴代码里面的注释接口字段变动,还得去更新文档,更新不及时导致文档不同步或者你使用了swagger之类的基于注解,依靠运行时的文档工具,看 ...
一款零注解API接口文档生成工具
smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中.只需要按照java-do ...
springboot项目集成java接口文档生成工具knife4j
knifie knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,轻量,并 ...
接口文档生成工具Swagger2的使用
一.什么是Swagger Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方 ...

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

接口文档生成工具ApiPost挺好用相关推荐

最新文章

热门文章