nodejs⾃动⽣成接⼝⽂档_使⽤apipost⼯具快速⽣成在线接⼝
⽂档
ApiPost是⼀个⽀持团队协作,并可直接⽣成⽂档的API调试、管理⼯具。它⽀持模拟POST、GET、PUT等常见请求,是后台接⼝开发者或前端、接⼝测试⼈员不可多得的⼯具 。使⽤者不仅可以利⽤apiopst调试接⼝,还可以书写相关注释(接⼝⽂档),⽅便的⽣成可读性好、界⾯美观的在线接⼝⽂档。
本⽂主要包含以下内容:
介绍ApiPost⼯具,它能做什么
下载、安装的⽅法
⼀些常⽤的操作
介绍⼀些使⽤技巧
前⾔:apipost能做什么?
ApiPost是⼀个⽀持团队协作,并可直接⽣成⽂档的API调试、管理⼯具。它可以像postman那样⽀持模拟POST、GET、PUT等常见请求也可以快速⽣成接⼝⽂档,是后台接⼝开发者或前端、接⼝测试⼈员不可多得的⼯具 。⾸先看下它的界⾯风格。
下载、安装apipost
ApiPost安装下载⼗分简单,在官⽹(⾃⾏百度)直接下载对应操作系统的安装包(⽀持window、mac、linux)安装即可,官⽹也提供了丰富的安装⽂档,这⾥不再赘述了。
⼀些常⽤的操作
ApiPost⽀持常见的接⼝发送、⽂档⽣成等。作为⼀名开发者,相信你从上⾯截图就可以基本看出来它的使⽤⽅法。这⾥主要介绍⼀些其他的常见操作。不过初次使⽤的时候,需要先注册⼀个账号,创建⼀个项⽬,然后点击左侧的 APIS 菜单栏就进到控制台了。
以下图是针对⽬录的常⽤操作
总之使⽤基本很简单,你下载安装⼀看就会了,实在有问题可以去官⽹查看⽂档或者去社区提问。⼀些操作技巧
⼩技巧之:快速导⼊参数
apipost⽀持多种格式的参数导⼊,见下图,你再也不⽤⼀个⼀个参数的慢慢写了:
导⼊格式⽀持key-value和json格式:
1-1:key-value格式导⼊⽰例:
key-value格式常见的就是浏览器(F12)控制台的数据格式,见下图:
我们,复制以上请求头参数,然后粘贴到apipost,点击导⼊
参数则瞬间导⼊到了请求参数中,见下图:
以上⽰例只是展⽰了如何快速导⼊到header参数,其他参数⽐如query、body操作⽅式是⼀模⼀样滴。1-2:json格式导⼊⽰例:
apipost也⽀持json格式的参数导⼊,参数格式可以如下:
{"id":123,"title":"我是标题"}
如图,点击导⼊,参数也快速导⼊到了请求参数中。
⼩技巧之:参数注释⾃动识别
上⾯我们写了如何快速导⼊参数,其实对于⽣成接⼝⽂档来说,参数描述(注释)才是最要命的,对于我们⼀直忙碌的程序员,花⼤量时间⽤在写⽂档上实在太累!
好在apipost帮我们节省了很多时间,⼀个参数,只要写过⼀次注释,下次遇到同样的参数直接选中就⾏。举例:
js获取json的key和value在上图中,我们针对id和title写了对应的注释:
id:“我是⽂章Id”
title:“我是⽂章标题”
当我们新建⼀个接⼝的时候,假如这个接⼝同样⽤到了id或者title等参数,点击参数描述就会呈现出刚刚输⼊过的参数描述,直接选中即可,不⽤再⿇烦的打字输⼊了。
这个⼩功能是不是节约了开发⼩伙伴很多时间呢?
⼩技巧之:快速定位当前接⼝⽬录
左侧的⽬录默认都是闭合的,有时候我们不知道当前正在编辑的接⼝属于哪个⽬录,起来相当头疼。apipost提供了“定位到当前接⼝⽬录” 功能(见下图),可以快速打开当前正在编辑的接⼝、⽂档
所在的⽬录,是不是解决了您的⼤问题了呢?
其实,apipost还有很多很多更加符合中国⼈操作习惯的⼩功能,等待您去发现。
⼩技巧之:⽣成并分享在线接⼝⽂档
说了这么多,好像还没说到重点,apipost怎么⽣成接⼝⽂档呢?很简单:新版ApiPost⽀持分享单个项⽬、也⽀持分享单个⽬录或者⽂档:
⽀持设置⽂档链接的有效期:
⽀持设置⽂档的查看权限:
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论