【Day 7】Google Apps Script - 使用 Google Docs 撰写 Demo 用的 API 文件

用 Google 文件把 API 规格描述出来，协作上比较方便，之後专案文件要列印装订成册交付，再转成 Word 列印出来装订。

今日要点：
》设计 API 要提供的功能
》制作 API 规格文件

前篇我们聊到了简单触发器，打铁趁热，今天我们先来使用 Google Docs 撰写 Demo 用的 API 文件，之後再依文件把 API 实作出来。在研究时，找到一篇介绍如何回传JSON格式的教学范例，里面使用到的 Gamil API 程序码超短的很好理解，就以它为基础改写一下扩充一下功能，让 API 文件看起来复杂一点(咦!)。

因为平常系统的API都蛮复杂的，想说把输出输入设计的长一点比较完整，不过改完还是很简单。先用 Google 文件把 API 规格描述出来，协作上比较方便，之後专案文件要列印装订成册交付，再转成 Word 列印出来装订。

制作「查询Gamil资讯」API规格文件

这是我们假设的「查询Gamil资讯」API 格式，看专案需求，每个专案文件的表格都不太一样，但大致会描述一下 API 的名称、功能的描述、呼叫的方式、输出输入的值是什麽，最後再加上使用的范例参考。

这个 API 我们设计可以查询 Gmail 的一些资讯，
输入值有：

• 查询人的姓名
• 要呼叫的功能名称

回传值有：

• 对查询人的问候语
• 未读信件的数量
• 垃圾信件的数量
• 最新5笔信件的标题

撰写好的「查询Gamil资讯」API 文件如下图：

参考

• How to serve JSON using the Google Apps Script Content Service