关于postman:ApiKit-简介安装以及如何使用

44次阅读

共计 4699 个字符，预计需要花费 12 分钟才能阅读完成。

一、介绍

ApiKit 是接口治理、开发、测试全流程集成工具，定位 API 治理 + Mock + 自动化测试 + 异样监控 + 团队合作。

1、开发测试过程中的现状
yapi — 治理接口文档
rap — 前端开发 mock 数据
postman — 开发调试接口、测试调用接口
jmeter — 根本的压力测试

2、存在的问题和痛点

  • 接口文档和理论开发的接口数据类型可能存在不统一，导致前后端未达成对立，测试时遇到问题，消耗工夫；
  • 一个接口，至多被定义四次：服务端开发调试时、前端开发 mock 时、接口测试时、jmeter 压测时，在需求量大，开发、测试工夫紧迫时，反复定义接口，显得有些浪费资源；
  • 测试中有时须要通过更改数据库数据，再调用接口，来进行测试，频繁操作时，比拟麻烦；

3、用 ApiKit 能够解决的问题

  • 进步开发接口数据类型的标准型，前后端单方都齐全恪守接口定义的标准，使得联调更加顺利；
  • 进步服务端冒烟通过率，开发定义好接口并调通后，能够立刻保留为一个测试用例，测试能够在提测前依据这个模板提前编写接口测试用例给开发自测；
  • 数据共享，只需开发定义一次接口，即可实现多种操作，缩小别人因为配置谬误等问题导致的接口调试失败几率，从而节俭肯定的工夫；
  • 连贯数据库，疾速筹备须要的测试数据；

二、装置

下载安装包后，一键装置即可。下载链接：
https://www.eolink.com/?utm_source=cpsf&utm_content=cpy08

三、应用

1、应用场景

后端开发

  • 接口文档治理
  • 后端代码主动生成
  • 接口调试
  • 接口自测

前端开发

  • 接口文档治理
  • 接口数据 Mock
  • 接口调试
  • 前端代码主动生成

测试人员

  • 接口调试
  • 接口测试
  • 性能测试

2、基本功能

API 测试

进入 API 文档详情页，点击上方 测试 标签，进入 API 测试页，零碎会依据 API 文档主动生成测试界面并且填充测试数据。

填写申请参数

首先填写好申请参数。

申请头部
您能够输出或导入申请头部。批量导入的数据格式为 key : value，一行一条 header 信息，如：

Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json
Date: Mon, 30 Dec 2019 20:49:45 GMT

申请体

申请体提供了五种类型：

  1. Form-data（表单）
  2. JSON
  3. XML
  4. Raw（自定义文本类型数据）
  5. Binary（字节流、文件参数）
    产品中提供了的 JSON 和 XML 编辑器，当您曾经在 API 文档中定义好 API 的申请数据结构时，只须要在测试界面填写各个字段的值，零碎会主动转换为相应的 JSON 和 XML 构造的申请数据。

Query 参数

Query 参数指的是地址栏中跟在问号？前面的参数，如以下地址中的 user_name 参数：
/user/login?user_name=jackliu

批量导入的数据格式为 ?key=value，通过 & 分隔多个参数，如：

api.eolinker.com/user/login?user_name=jackliu&user_password=hello

REST 参数
REST 参数指的是地址栏被斜杠 / 分隔的参数，如以下地址中的 user_name、user_password 参数。

/user/login/{user_name}/{user_password}

留神，只须要在 URL 中应用 {} 将 REST 参数括起来，下方的申请参数名中不须要应用 {}。

解决脚本
脚本分为 前置脚本 和 后置脚本 两种，别离对应 API 申请前 和 返回数据后 的两个阶段。您能够通过编写 Javascript 代码，在 API 前置脚本中扭转申请参数，或者是在 API 后置脚本中扭转返回后果。

脚本罕用于以下几种状况：

  1. API 申请前对申请参数进行复制、加解密等操作，比方进行 Body 进行整体签名
  2. API 返回后果后对后果进行解密等
    发动的 API 申请会顺次通过以下流程。其中如果您没有编写相应的 API 脚本，则会略过 API 脚本解决阶段。

治理 Cookie

当您测试须要 Cookie 的 API 时，能够先进行一次 API 登录或者在 Cookie 治理里增加所需的 Cookie 信息，零碎会主动将 Cookie 储存起来，下次测试其余雷同域名的 API 时会主动传递 Cookie 申请参数。

查看测试后果
填写好申请参数后，点击测试按钮即可失去测试报告，报告包含以下内容：

  1. 返回头部
  2. 返回内容
  3. 理论申请头部
  4. 理论申请内容
  5. 申请工夫剖析

创立 / 生成 API 文档
在 API 研发治理产品中，简直所有的合作工作都是围绕着 API 文档进行的。

咱们在接触了大量的客户后发现，采纳 文档驱动 的合作模式会比先开发、后保护文档的形式更好，团队合作效率和产品质量都能失去进步。因而咱们建议您尝试基于文档来进行工作，应用 文档驱动 形式来升高大量无意义的沟通老本。

当您创立了 API 文档之后，您能够随时查看 API 的改变状况、依据 API 文档发动 API 测试、编写 API 测试用例、应用 Mock API 等。

如下图是在零碎中治理的 API 文档，能够具体的看到 API 的形容信息、变更历史、测试用例、Mock API 等内容。

创立 API 文档
在我的项目详情页点击左侧 API 文档性能，进入 API 治理页面，点击 增加 API，会进入 API 创立页面。
公有云产品比线上 SaaS 产品反对更多的 API 协定，比方 Websocket、TCP、UDP、SOAP、HSF 等。

编辑 API 文档
在 API 形容标签页中填写 API 的申请门路、API 名称、标签、负责人等根本信息。

  1. API 状态：能够不便成员查看 API 以后所处的状态，并且进行状态流转的告诉;
  2. Tag 标签：能够作为 API 的备注或者是筛选条件;
  3. 负责人：当 API 文档内容发生变化时，负责人会主动收到 API 变更告诉。

API 申请参数

设置申请头部（request header）

您能够输出或导入申请头部。

批量导入的数据格式为 key : value，一行一条 header 信息，如：

Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json
Date: Mon, 30 Dec 2019 20:49:45 GMT

设置申请体（request body）
申请体提供了五种类型：

  1. Form-data（表单）
  2. Json
  3. XML
  4. Raw（自定义文本类型数据）
  5. Binary（字节流、文件参数）
    对于 Form-data（表单）、Json、XML 等数据类型，能够通过援用当时编辑好的 数据结构 来疾速填写内容。

设置 Query 参数
Query 参数指的是地址栏中跟在问号？前面的参数，如以下地址中的 user_name 参数：

/user/login?user_name=jackliu

批量导入的数据格式为 ?key=value…，通过 & 分隔多个参数，如：

api.eolinker.com/user/login?user_name=jackliu&user_password=hello

设置 REST 参数
REST 参数指的是地址栏被斜杠 / 分隔的参数，如以下地址中的应用大括号包裹起来的 user_name、user_password 参数：

/user/login/{user_name}/{user_password}

留神，您只须要在 URL 中应用 {} 将 REST 参数括起来。API 文档和测试时，下方表格的参数名不须要应用{}。

API 响应内容

设置响应头部（response header）
您能够输出或导入响应头部。批量导入的数据格式为 key : value，一行一条 header 信息，如：

Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json
Date: Mon, 30 Dec 2019 20:49:45 GMT

设置响应内容（response body）
响应内容的编写形式和申请参数的相似，响应内容提供了四种类型：

  1. Json
  2. XML
  3. Raw（自定义文本类型数据）
  4. Binary（字节流、文件参数）
    对于 Json、XML 等数据类型，能够通过援用当时编辑好的 数据结构 来疾速填写内容。零碎也提供了导入性能不便您疾速导入参数信息。

创立 Mock API
1、进入 API 文档详情页面，点击 “ 高级 Mock” 标签，点击 ” 增加 Mock”。

2、在弹窗中填写 Mock API 的触发条件和返回后果。

  • 触发条件反对申请头部、申请体（Form-data、JSON）、Query 参数等。以下例子示意当 Form-data 参数中蕴含 user_name = jackliu 时，返回预设的 JSON 字符串。
  • 返回后果除了返回固定的任意内容之外，零碎还能够依据您的接口文档主动生成返回后果，或者通过 Javascript 生成简单的返回数据等，相干教程能够查看具体的 Mock API 教程

调用 Mock API
进入 Mock API 列表页面，点击调用地址即可复制到剪贴板，在代码中间接对该 API 地址发动申请即可失去响应后果。通过拜访该 Mock API URL，能够依据不同的申请参数返回相应的冀望后果。

分享 API 文档

开启 / 敞开在线分享

您能够在线分享我的项目给团队以外的人，其他人能够通过分享链接在线查看 API 文档并且进行 API 测试。通过这种形式查看 API 文档不须要注册账号，用户可不便查看接口文档和测试接口。

在我的项目内，点击进入项目管理菜单，抉择 在线分享，即可启用或禁用我的项目在线分享性能。

进入点击 我的项目页面顶部的 分享我的项目 按钮，亦可启用或禁用我的项目在线分享性能。

设置拜访明码

默认无需明码拜访我的项目，开启须要明码拜访后，零碎会默认提供 6 位数明码，明码蕴含数字和字母。
用户可自定义明码，输出明码并输入框失焦后会主动保留新密码。内部人员下次访问页面时须要输出新密码才可拜访。

设置访客可进行的操作
可设置分享我的项目可见页面，用于管制内部人员通过链接拜访时可查看的我的项目页面，零碎默认可见全副。全副页面蕴含：API 文档页、API 测试页、API 测试用例页、状态码文档页、高级 Mock 页、我的项目文档页。其中 API 文档页是必选，必定会对外展现。

设置访客可查看的我的项目环境
可设置我的项目环境权限，用于管制内部人员可用的测试环境，零碎默认可选全副我的项目内的环境。留神仅蕴含该我的项目内创立的环境，不会蕴含利用级的公共环境。

开启之后，访客能够在我的项目分享页右上方看到环境切换菜单。

设置 API 文档范畴

可设置分享范畴，用于管制内部人员可查看的 API 文档范畴，零碎默认可查看我的项目内所有 API。用户可进行逐个勾选。零碎默认分享所有 API

邀请成员一起合作
在 Apikit 中，所有的 API 接口都是以我的项目的形式进行治理，因而首先须要创立一个 API 治理我的项目。

除了创立 API 我的项目，还能够创立项目组来对我的项目进行分类或者设置对立的用户操作权限。

一、手动创立我的项目
进入 API 研发治理我的项目列表页，点击 增加我的项目 按钮。

在弹窗中输出项目名称等信息，点击确认即可创立 API 治理我的项目。

二、导入第三方产品数据
除了手动创立我的项目，零碎也提供了一键导入 Swagger、Postman、RAP、YAPI 等产品数据的性能。

三、邀请成员退出空间
领有管理员权限，在用户界面的右上方，点击增加空间成员，通过链接邀请空间成员。

四、增加合作成员
进入我的项目的人员治理页面，点击 增加合作成员 按钮，在弹窗中抉择须要增加的成员以及赋予的角色。

能够将团队成员增加到该我的项目中进行合作。留神：成员只有被增加到该我的项目后能力看到我的项目内容。

零碎默认有我的项目管理员、只读、可编辑等默认角色，您也能够依据须要创立新的自定义角色：

对于 ApiKit 的更多功能，值得你来尝试体验！

正文完
postman
发表至： postman
2023-05-24
 0
关于postman:接口测试参数化环境变量使用apipost
关于postman:从Postman到ApiPost码农闰土
关于postman:INFT216-Data-Science
关于postman:中国版PostmanApifox