【Day 25】Google Apps Script - API Blueprint 篇 - 执行专案取得 .apib 档

执行 Google Docs 转换 API Blueprint 格式专案程序，最後来看看转换後的 .apib 档内容吧。

今日要点：
》执行 Google Apps Script 专案
》查看转换後的 .apib 档内容

执行 Google Apps Script 专案

前二天我们把专案的程序码都简单介绍了一下，接下来就来执行看看罗。在上面的功能列，选择我们主要的入口函式 goGet(e)，再点选执行。

执行完後会在云端硬碟的指定目录里产生一个 .apib 档，如下图所示：

转换後的 apib 档内容

转换後的 apib 档内容分为几个部份，可以参考【Day 22】Google Apps Script - API Blueprint 篇 - API Blueprint 格式范例

Metadata

HOST: https://script.google.com
FORMAT: 1A

API Name & Description

# 铁人赛 2021 
## Version
v1.0

Resource Groups (资源群组)

# Group API文件Demo

Resource (资源) / API Name

## 查询Gmail资讯 [/macros/s/AKfycbyLOQLi_p2I2y0TQ4IrQ8vV53rtMSRdunWLqFJB5pBhHG9frBOf7rKB0Yunfl6x1twr/exec{?name,func}]

API Description

这里的 API 描述主要是以表格呈现为主，Markdown 的也有表格的语法，但好像不能弹性的合并栏位，所以这里还是转成 html的语法。在这个示范专案，执行专案後，一共会汇出 4 个 API 描述段落表格至 .apib 档里。

API Description - 1

<table>
    <tr>
        <th>Docs Demo</th>
        <th>getGmailInfo</th>
        <th>查询Gmail资讯</th>
    </tr>
    <tr>
        <td>说明</td>
        <td colspan=2> 使用 Google Apps Script 查询 Gmail 资讯。</td>
    </tr>
</table>

API Description - 2

<table>
    <tr>
        <th colspan=3><b> Request Url Params </b></th>
    </tr>
    <tr>
        <th>键值</th>
        <th>型别</th>
        <th>说明</th>
    </tr>
    <tr>
        <td> name</td>
        <td> String</td>
        <td>查询人的姓名</td>
    </tr>
    <tr>
        <td> func (必填)</td>
        <td> String</td>
        <td>要呼叫的功能名称</td>
    </tr>
</table>

API Description - 3

<table>
    <tr>
        <th colspan=3><b> Response Body</b></th>
    </tr>
    <tr>
        <th>键值</th>
        <th>型别</th>
        <th>说明</th>
    </tr>
    <tr>
        <td> hello</td>
        <td> String</td>
        <td>对查询人的问候语</td>
    </tr>
    <tr>
        <td> unreadCount</td>
        <td> Number</td>
        <td>收件夹中未读信件的数量</td>
    </tr>
    <tr>
        <td> spamCount</td>
        <td> Number</td>
        <td>垃圾信件夹中的未读数量</td>
    </tr>
    <tr>
        <td> messageSubject</td>
        <td> ArrayObject</td>
        <td>最新5笔信件的标题</td>
    </tr>
</table>

API Description - 4

<table>
    <tr>
        <th colspan=2><b> Sample</b></th>
    </tr>
    <tr>
        <th>Method</th>
        <th>GET</th>
    </tr>
    <tr>
        <td>URL</td>
        <td>https://script.google.com/macros/s/AKfycbyLOQLi_p2I2y0TQ4IrQ8vV53rtMSRdunWLqFJB5pBhHG9frBOf7rKB0Yunfl6x1twr/exec</td>
    </tr>
    <tr>
        <td>Request</td>
        <td>?name=Jason&func=getGmailInfo</td>
    </tr>
    <tr>
        <td>Response</td>
        <td>{<br>  "hello": "Jason 您好!",
             <br>  "unreadCount": 3,
             <br>  "spamCount": 1,
             <br>  "messageSubject": [
             <br>    "Important updates to our data protection terms",
             <br>    "决定了!就用「上海商银台湾Pay」绑定数位振兴五倍券!!",
             <br>    "【小编也不喜欢看人家脸色… ><】资金周转自己来，中信信贷线上申办！",
             <br>    "数位振兴五倍券绑定台湾银行台湾Pay，最高加码4500元！",
             <br>    "谷歌 正在招募：Technical Program Manager, Google Phone Software。"
             <br>  ]
             <br>}
             <br>
         </td>
    </tr>
</table>

MSON

MSON 是 Markdown Syntax for Object Notation 的缩写，它是一种以人类可读的纯文本形式表示数据结构的方法。这边就先不多做介绍，有兴趣的话可以查看参考所附的连结。

Actions(动作)

### try:查询Gmail资讯 [GET]

URI Parameters(参数)

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

+ Response 200 (application/json)

上述的 .apib 各段落对应画面，如果用 apiary 的视觉化来展示，就如【Day 22】API Blueprint 格式范例所介绍的对应图如下图所示，可以再一起比对看一下：

以上就是 Google Docs 转换 API Blueprint 格式後的 .apib 档的内容介绍了，明天我们开始介绍 apiary。

参考

• 【Day 23】Google Docs 转换 API Blueprint 格式(1)
• 【Day 24】Google Docs 转换 API Blueprint 格式(2)
• MSON Specification
• MSON Tutorial