告别 Postman!让我们轻松在团队中分享您的 REST API 调用!
作为开发人员,我们正在使用工具进行 REST API 调用(Postman、Insomnia、PostWoman……),这些工具非常有用。
限制
调用测试 API 是可以的,但是如果您想编辑、版本控制或只是与您的团队共享它……那就不是很方便。
确实,您可以使用 Postman 付费计划,但这意味着您需要付费,也意味着您的整个团队都需要使用 Postman,这又是一个工具……
您了解REST 客户端吗?
REST Client * 是VS Code 扩展。
它允许你向 VS Code发送 HTTP 请求并查看响应。而且仅基于文本文件,该文件可以轻松地在你的存储库中进行版本控制。🙏
优点
主要优点是能够对 API 调用进行版本控制和共享。
如果您正在使用内部 API,您可能希望与同事分享如何测试新端点。
REST 客户端是一种简单易行的好方法!
另一个优点是简洁。你只需要一个文件。此外,如果你在项目之间跳转,并且记不清某个很久没用过的 API/服务是如何运作的,只需查看这个文件即可!
缺点
您必须使用 VS Code...但由于互联网上许多已知的原因,您正在使用 Emacs、VI 或 VS Code 😄
下一步是什么?
以下是如何开始。
文件
仅创建扩展名为 .http 的文件,例如 doc.http
# REST Client tests on https://github.com/tronalddump-io/tronald-app | |
@baseUrl = https://api.tronalddump.io | |
### Get a random clever quote | |
GET {{baseUrl}}/random/quote | |
Accept: application/hal+json |
然后,VS Code 将显示该文件:
点击“发送请求”后,将打开一个包含所有请求响应详细信息的新选项卡。
更进一步
您还可以使用环境变量轻松地在环境之间切换,并避免在文件中手动更新任何 api-key 或令牌,或更新 url 等...
以下是如何使用环境变量,就像这样:
在这里,我创建了 4 个环境:本地、开发、暂存、生产。
这 4 个环境都有各自的 host 和 token 变量,并带有特定的值。
但它们也共享一个名为 的变量partnerUniqueToken
(别问我为什么……太多伙伴没有多个环境了……)。
希望有帮助!