本期推荐的Hoppscotch是一个开源的API 开发生态系统。
Hoppscotch特征
轻量级:采用简约的 UI 设计精制而成。
快速:实时发送请求和获取/复制响应。
HTTP 方法
- GET- 请求检索资源信息
- POST- 服务器在数据库中创建一个新条目
- PUT- 更新现有资源
- PATCH- 非常类似于PUT但对资源进行部分更新
- DELETE- 删除资源或相关组件
- HEAD- 检索与 GET 请求相同的响应标头,但没有响应正文。
- CONNECT- 建立到目标资源标识的服务器的隧道
- OPTIONS- 描述目标资源的通信选项
- TRACE- 沿着到目标资源的路径执行消息环回测试
- <custom>- 一些 API 使用自定义请求方法,例如LIST. 输入您的自定义方法。
主题化
- 选择主题:系统(默认)、浅色、深色和黑色
- 选择强调色:绿色(默认)、蓝绿色、蓝色、靛蓝、紫色、黄色、橙色、红色和粉色
- 无干扰的禅宗模式
自定义主题与云/本地会话同步
PWA:在您的设备上安装为PWA 。
- 使用 Service Worker 即时加载
- 离线支持
- 低 RAM/内存和 CPU 使用率
- 添加到主屏幕
- 桌面 PWA
请求:立即从端点检索响应。
- 选择method
- 进入URL
- 发送
- 复制/共享公共“共享 URL”
- 为 10 多种语言和框架生成/复制请求代码片段
- 进口cURL
- 标签请求
WebSocket:通过单个 TCP 连接建立全双工通信通道。
服务器发送的事件:通过 HTTP 连接从服务器接收更新流,而不诉诸轮询。
Socket.IO:使用 SocketIO 服务器发送和接收数据。
MQTT:订阅和发布到 MQTT 代理的主题。
GraphQL: GraphQL 是一种用于 API 的查询语言,也是一种使用现有数据完成这些查询的运行时。
- 设置端点并获取架构
- 多栏文档
- 设置自定义请求标头
- 查询架构
- 获取查询响应
授权:允许识别最终用户。
- 没有任何
- 基本的
- 不记名令牌
- OAuth 2.0
- OIDC 访问令牌/PKCE
标头:描述发送请求正文的格式。
参数:使用请求参数来设置模拟请求中的不同部分。
请求正文:用于通过 REST API 发送和接收数据。
- 放Content Type
- FormData、JSON 等
- 在键值和 RAW 输入参数列表之间切换
响应:包含状态行、标题和消息/响应正文。
- 将响应复制到剪贴板
- 将响应下载为文件
- 查看响应标头
- 查看 HTML、图像、JSON、XML 响应的原始和预览
历史记录:请求条目与云/本地会话存储同步,只需单击即可恢复。
集合:使用集合和文件夹组织您的 API 请求。只需单击一下即可重复使用它们。
- 无限的收藏、文件夹和请求
- 嵌套文件夹
- 作为文件或 GitHub gist 导出和导入
集合与云/本地会话存储同步
代理:从设置中启用代理模式以访问被阻止的 API。
- 隐藏您的 IP 地址
- 修复CORS(跨域资源共享)问题
- 访问在非 HTTPS ( http://) 端点中提供的 API
- 使用您的代理 URL
快速入门指南
Hoppscotch UI 由以下组件组成:
- 顶部栏允许您查看我们的存储库,使用您的帐户登录并提供有用的链接。
- 左侧边栏提供对可用于 Web 开发的工具套件的访问。
- 您可以在右下角更改您的首选语言。
REST API 平台
- 中心区域是您构建和处理 API 请求的地方。
- 在分隔线下方的左侧边栏中是图标,可将您引导至请求、选项和响应的特定窗格。
- 右侧面板允许您查看最近的 API 请求历史、集合和环境。
历史
显示您最近发出的 API 请求,让您从离开的地方重新开始。
收藏
Hoppscotch 允许您使用集合和文件夹来组织 API 请求。
环境
在您的请求和脚本中存储变量和重用值 要设置环境,请从可用环境的下拉列表中进行选择。
GraphQL 编辑器
- 中心区域是您使用 graphql 查询的地方。
- 在分隔线下方的左侧边栏中是图标,可将您引导至 Schema、Query 和 Response 的特定窗格。
- 右侧面板包含用于模式文档、查询、历史记录和集合的选项卡。为方便起见,可以隐藏此面板。
API 文档生成器
您可以导入集合。或者从右侧面板中选择您在 Hoppscotch 中制作的现有收藏。单击生成文档以获取 API 文档。
拦截器和附加组件
使用 proxyscotch/自定义中间件或 Hoppscotch Web 扩展访问被 CORS 限制阻止的 API。
使用代理
在设置中启用代理。
ProxyScotch 的工作原理
使用自定义中间件
由于CORS就像添加一些 HTTP 标头一样简单,并且它是唯一被阻止的浏览器,因此您可以构建一些类似代理的组件,它基本上会为您进行调用,从所需的 API 获取响应,将这些标头添加到顶部,然后把它寄回跳房子。
使用 Hoppscotch 网络扩展
- 在此处下载 Hoppscotch 浏览器扩展程序。
- 在设置中启用它。
- 打开扩展并添加新的来源
Hoppscotch 扩展将所有添加的来源路由到代理。
API 文档
随时随地为您的 API 生成文档。使用集合中的 API 或导入本地集合并获取 API 文档作为gist可在协作者之间共享的秘密。
—END—
开源协议:MIT license