【Day 28】Google Apps Script - API Blueprint 篇 - Apiary 测试 API 介绍

Apiary 把文件与类似 postman 的功能结合在一起，可以边看文件边测试。

今日要点：
》Apiary 测试 API 介绍

Apiary 测试 API 介绍

经过前面的准备，我们可以分享给别人来测看看 API 是否正常了，你可以点选上方的 Documentation 後, 就可以看到分享的画面。

把上面的网址贴给别人就可以来看文件和测试API了，他预设分享的网址是 你的专案名称.docs.apiary.io/

这里是我的范例的 Apiary 网址 https://jasonithelp2021.docs.apiary.io/ 可以来玩看看。
　

　
Apiary 可以让你直接测试 Api，用起来很像我们用 postman 在测 API 一样，很方便。

首先点选下方的　

再点选右上的

会看到测试的设定画面

因为我们在 Action 有写好 Get 的参数如下:

+ Parameters
    + name: Jason (string, optional) -查询人的姓名
    + func: getGmailInfo (string, required) - 要呼叫的功能名称

所以你可以看到在画面上已经预设有二个参数了，因为 name 不是必要的参数，所以预设没有勾选，你可以在这里把他勾起来。

再来我们要选 server，我们先实际打到正式的 Google server 去, 所以先选 Production

选了 Production 之後，你可以看到上方的 Get 前面网址 domain name 会变为 https://script.google.com/...

如果是选了其他的如 Mock server，你可以看到上方的 Get 前面网址 domain name 会变为 https://private-anon-52ad759595-jasonithelp2021.apiary-mock.com/...

按下 Call Resource 就可以看到 Google server 回传的结果, 预设是在 Diff 标签，他可以帮你比对回传值跟你在文件 Specification 打的值有没有不一样的地方，不一样的地方会用绿色背景突显出来。

你可以切到 Real 看实际的回传样子，下方的 Json 格式他帮你排好看一点。

如果你是用 Mock server 去打，那在上方的 Inspector 会有记录可以查看，对模拟服务器的任何请求或响应都将被记录在 Inspector，所以我们也可以使用喜欢的工具（例如 curl 或 Paw）来呼叫 API，细节可以查看参考所附的连结。

以上就是使用 Apiary 测试 API 的介绍了。呼~ 总算写好了，今天有点忙... !