文章采集api(ApiPost支持团队协作,可直接生成文档的API调试、管理工具)

优采云 发布时间: 2021-09-09 22:11

  文章采集api(ApiPost支持团队协作,可直接生成文档的API调试、管理工具)

  ApiPost 是一个 API 调试和管理工具,支持团队协作,可以直接生成文档。支持POST、GET、PUT等常见请求的模拟,是后端接口开发人员或前端和接口测试人员不可多得的工具。用户不仅可以使用apiopst调试界面,还可以编写相关注释(界面文档),轻松生成可读性好、界面美观的在线界面文档。

  本文主要收录以下内容:

  介绍 ApiPost 工具及其功能

  如何下​​载和安装

  一些常见的操作

  介绍一些技巧

  前言:apipost 能做什么?

  ApiPost 是一个 API 调试和管理工具,支持团队协作,可以直接生成文档。支持模拟POST、GET、PUT等postman等常见请求,快速生成接口文档。是后端接口开发人员或前端和接口测试人员不可多得的工具。先看它的界面风格。

  

  下载并安装apipost

  ApiPost 的安装和下载非常简单。可以直接到官网(自行百度)下载对应操作系统(支持window、mac、linux)的安装包并安装。官网还提供了丰富的安装文档,这里不再赘述。

  一些常见的操作

  ApiPost 支持常用的接口发送、文档生成等,作为开发者,相信你从上面的截图基本可以看出怎么使用了。下面是一些其他常见的操作。但是第一次使用需要注册账号,创建项目,然后点击左侧的APIS菜单栏进入控制台。

  下图是对目录的常用操作

  

  总之,使用基本上很简单,看到就下载安装。如有疑问,可以到官网查看文档或到社区提问。

  一些操作技巧

  提示:快速导入参数

  apipost支持多种格式的参数导入,如下图所示,再也不用一一慢慢写了:

  

  导入格式支持 key-value 和 json 格式:

  

  1-1:键值格式导入示例:

  常见的key-value格式为浏览器(控制台的F12)数据格式,见下图:

  

  我们,复制上面的请求头参数,然后粘贴到apipost中,点击import

  

  参数瞬间导入到请求参数中,如下图:

  

  上面的例子只是展示了如何快速导入header参数,其他的query、body操作等参数完全一样。

  1-2:json格式导入示例:

  apipost 也支持json格式的参数导入,参数格式可以如下:

  { "id": 123, "title": "我就是标题" }

  

  如图,点击Import,参数快速导入到请求参数中。

  

  提示:自动识别参数注释

  上面我们写了如何快速导入参数。实际上,参数描述(注释)是生成接口文档最可怕的。对于一直很忙的程序员来说,花大量时间写文档实在是太累了。 !

  幸运的是,apipost 为我们节省了大量时间。对于一个参数,只要写一次注释,下次就可以选择同一个参数。示例:

  

  在上图中,我们为id和title写了相应的注释:

  id:“我是文章Id”

  title:“我是文章title”

  当我们新建一个界面的时候,如果界面还使用了id或者title等参数,点击参数说明会显示刚刚输入的参数说明,选择就可以了,不用再麻烦打字了。

  

  这个小功能是否为开发者节省了大量时间?

  提示:快速定位当前界面目录

  左边的目录默认关闭。有时我们不知道当前正在编辑的界面属于哪个目录,查找起来很头疼。 Apipost 提供了“定位到当前界面目录”功能(见下图),可以快速打开当前正在编辑界面和文档的目录。它解决了你的大问题吗?

  

  其实apipost还有很多更符合中国人操作习惯的小功能,等你去发现。

0 个评论

要回复文章请先登录注册


官方客服QQ群

微信人工客服

QQ人工客服


线