Api Post快速上手教程

Apipost快速上手教程可以按照以下步骤进行：

一、准备工作

1. 访问Apipost官网下载并安装Apipost客户端，或者选择使用其Web端版本。
2. 注册并登录Apipost账号，以便更好地管理和使用你的项目。
3. 官网：Apipost-API 文档、设计、调试、自动化测试一体化协作平台

二、新建接口

1. 在Apipost中，点击项目后的加号，选择"新建接口"。
2. 在新建接口页面，输入接口名称，选择请求方式（如GET、POST等），并填写接口地址。
3. 根据需要，设置请求参数，包括Query参数、Body参数、Header参数、路径参数以及认证参数等。
   • Query参数：类似Postman的Params，即URL中?后面的参数。
   • Body参数：请求体，支持FormData、urlencoded（x-www-form-urlencoded）、raw类型。根据需求选择合适的类型并填写参数。
   • Header参数：请求头，可以设置或导入Header参数，包括cookie等。
   • 路径参数：针对restful风格结构，可以用:变量名来表达参数。

三、发送请求并查看结果

1. 在请求参数设置完成后，点击右侧的"发送"按钮执行接口请求。
2. 在响应区域，可以查看接口返回的数据、Header、Cookie、状态码、请求时长等信息。
3. 如果有需要，可以保存响应结果为响应示例，方便后续查看和对比。

请求地址

Method：支持下拉选择多种Method请求方式

URL：在地址栏可直接输入接口的请求地址

协议：目前支持http1.1、http2协议的发送

Header​

header入参：支持下拉快速查找常用的header参数名，输入请求参数值

Query​

query入参：设置的query参数值会自动拼接到url地址中；并且可通过 = 的设置，来定义请求接口时参数值为空是否需要拼接 "="号

Body​

body入参：支持多种数据格式 none form-data urlencode（即x-www-form-urlencoded） binary raw（json/xml/javascript/plain/html）

• none 格式表示body无请求正文

• 当你需要提交有文件的表单时，切换到 form-data

• 当你需要提交表单时，切换到 urlencoded

当您需要发送JSON对象或者其他对象时，切换到对应的raw类型即可 raw（json/xml）格式，支持数据结构（可以了解数据结构的使用）设计带层级接口的json或xml的入参参数值

raw（javascript/plain/html）支持源码编辑方式设计入参的参数值

Path​

支持RESTful API设计，通过在接口路径中{} 或 : 的方式增加变量，添加后也会在入参中展示出来

认证​

支持Bearer auth认证、Basic auth认证、Digest auth认证、OAuth 1.0、Hawk authentication、AWS Signature、NTLM Authentication(Beta)、Akamai EdgeGrid八种认证方式。

调试发送时统一默认是在header中添加参数。

Cookie​

支持直接以key-value的形式填写cookie的请求内容

预执行操作/后执行操作​

预执行操作：在接口发送前执行的操作，支持添加自定义脚本和连接数据库的操作，例如进行加解密、获取数据库数据作为入参等（可查看相关文档了解具体使用）

后执行操作：在接口发送后执行的操作，支持添加自定义脚本、连接数据库、断言、提取变量的操作，例如对响应数据进行断言、或者获取部分数据作为变量（可查看相关文档了解具体使用）

实时响应​

代理和响应时间​

在系统设置里设置了使用代理也可在响应区内查看是否生效，可查看设置代理的使用文档

点击响应时间可以查看各个事件的耗时

提示

Request (请求): 从发出请求到开始进行套接字操作

Socket (套接字): 进行套接字操作的时间

Lookup (查找): DNS 查询的时间

Connect (连接): 建立连接到服务器的时间

SecureConnect (安全连接): SSL 安全连接建立的时间

Response (响应): 从服务器接收到响应的时间

End (结束): 结束请求的时间

Done (完成): 整个请求处理完成的时间

这些时间数据可以用来分析网络请求的性能，以确定哪个阶段花费了最多的时间，如果发现某个阶段耗时过长，就可以进行进一步的优化。

控制台​

控制台可具体查看接口的请求详情，包括通过预后执行脚本打印出的内容

响应示例​

断言与校验​

四、生成接口文档

1. 点击"分享文档"按钮，可以一键生成标准的接口文档。
2. 复制并打开文档地址，即可查看完整的接口文档。

五、其他功能

1. 自动化测试：利用Apipost提供的断言和流程测试功能，进行接口的流程化测试。
2. Mock数据：后端可以通过先编写Mock数据给前端，从而让前端提前进入接口调用、前端开发状态。
3. 序号代码生成：ApiPost提供主流语言代码自动生成功能，每编写一个接口，都支持生成主流语言代码。
4. 响应结果分屏展示：在APIPOST 5.4版本后，支持"响应结果分屏展示"，从而提升工作区的空间。
5. 断言功能：协作开发、版本升级、服务器升级时，可以使用断言功能进行响应结果的校验，以便更快地发现bug。

官方帮助文档：快速上手 | Apipost

关于优联前端

武汉优联前端科技有限公司由一批从事前端10余年的专业人才创办，是一家致力于H5前端技术研究的科技创新型公司，为合作伙伴提供专业高效的前端解决方案，合作伙伴遍布中国及东南亚地区，行业涵盖广告，教育， 医疗，餐饮等。有效的解决了合作伙伴的前端技术难题，节约了成本，实现合作共赢。