iT邦幫忙

2021 iThome 鐵人賽

DAY 7
0
IT管理

「Google Apps Script」 學習筆記系列 第 7

【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 文件如下圖:

參考


上一篇
【Day 6】Google Apps Script - 觸發條件與簡單觸發器(Simple Triggers)
下一篇
【Day 8】Google Apps Script - 依文件實作 Demo 用的 API
系列文
「Google Apps Script」 學習筆記30

尚未有邦友留言

立即登入留言