第6章 测试API

以下介绍两种常见的测试API接口方式，用户根据自己习惯任选一种。 我们为您提供了两种常用的测试API接口的方法，您可以根据自己的喜好选择其中一种。

6.1 平台自带的接口调试工具

使用APISQL云平台自带API接口调试工具，特点是简单，支持设计API时所用的参数。 在单个API接口的 概览 界面，点击 运行。

  • 点击 搜索，查看该API支持的所有请求参数，示例值：填写一个测试的参数。

  • 点击 【运行】 查看执行结果的JSON和HTTP信息 请求参数

  • 点击 认证信息， 切换认证方式，不鉴权(公开)、IP鉴权无须填写；API key、平台用户及密码认证需填写对应信息；

  • 点击 【查看HTTP信息】 可以查看HTTP的参数信息 切换认证

  • 最常用的 API key认证 秘钥，是在【访问控制】->【创建访问控制策略】->【复制】获取，不要忘记 绑定API组，这个API组才能使用该秘钥访问。 私钥位置

IP鉴权如下，使用是当前上网的IP地址，当前上网的IP可通过如www.ipip.net 查看。 IP鉴权认证

6.2 第三方接口调试工具

这里使用一个替代Postman的开源接口调试工具： https://hoppscotch.io ，初次打开网站， 设置 -> 选择 语言 和 启用 代理中间件发送请求 hoppscotch设置

出于安全优先的原则，APISQL默认所有请求都是POST以请求，以HTTPS加密，HTTP2传输，所以我们这里选择POST。 POST

请求的**【参数】** 是以json格式放在 请求体 中，如下：

{
    "params": {"id": 1}
}

请求体

API key认证 秘钥在【访问控制】->【创建访问控制策略】->【复制】获取。

复制秘钥

然后将API Key放 【请求头】 中，注意有Bearer前辍后面还有个空格，（这是一种常见的认证方式，表示您使用的是API key，空格是为了区分前辍和秘钥）格式如下。

"Authorization": "Bearer sk-e225739e757138943774899fcdd1acda"

请求头

在没有配置API Key就发送，会收到类似“BAD_TOKEN”的提示，如下图所示， 所以在调试时可以跟据对应的错误提示，知道是哪方面的问题，再进行对应配置即可。 未填写请求头报错

对于API接口管理，文档是少不了，方便以后一目了然的知道接口干什么的。 API文档

文档是以Markdown方式保存至平台（Markdown是一种轻量级的标记语言，可以方便地编写和格式化文本，支持标题、列表、表格、代码块等多种元素），方便同事一起查阅和修改。 API文档以Markdown方式编辑

到此，您应该已经掌握了如何使用APISQL云平台主要功能，来快速设计和管理您的API接口。希望这些能够帮助您提高开发效率和质量。如果您有任何疑问或建议，欢迎随时联系我们，感谢您的支持。

🌸🌸完结散花！🌸🌸

← 第5章 访问控制策略
AI模型 →