跳到主要內容

Action Modeling: Case Studies

Twitter REST API


POST collections/entries/add
POST collections/entries/curate
POST collections/entries/move
POST collections/entries/remove
不曉得是不是因為實作的關係,它的新增或移除都表達在URI上;另外它並沒有提供HATEOAS的功能。

Youtube Data API v3

幾乎都使用controller resource來表達特別的流程,link:
# Uploads a channel banner image to YouTube.
POST /channelBanners/insert
# Expresses the caller's opinion that one or more comments should be flagged as spam.
POST /comments/markAsSpam
# Uploads a custom video thumbnail to YouTube and sets it for a video.
POST /thumbnails/set
# Add a like or dislike rating to a video or remove a rating from a video.
POST /videos/rate
# Retrieves the ratings that the authorized user gave to a list of specified videos.
GET /videos/getRating
# Report a video for containing abusive content.
POST /videos/reportAbuse
# Uploads a watermark image to YouTube and sets it for a channel.
POST /watermarks/set
# Deletes a channel's watermark image.
POST /watermarks/unset
insert的部分不曉得是考量什麼特別使用了controller resource,因為POST應該就能表達新增了;而getRating的部分,應可以是store resource,名稱為rating。

Google Drive APIs v3

皆使用controller resource的形式,link:
# Subscribes to changes for a user.
POST  /changes/watch
# Subscribes to changes to a file
POST  /files/fileId/watch
# Stop watching resources through this channel
POST  /channels/stop
# Exports a Google Doc to the requested MIME type and returns the exported content.
GET  /files/fileId/export
但以export file來說,我會傾向於使用store resource並搭配Accept+Type:
Accept: text/plain
GET  /files/fileId/content

Google Fusion Tables API v2

皆使用controller resource的形式,link:
# Publishes a container version.
POST  /accounts/accountId/containers/containerId/versions/containerVersionId/publish
# Restores a Container Version. 
POST  /accounts/accountId/containers/containerId/versions/containerVersionId/restore
# Undeletes a container version.
POST  /accounts/accountId/containers/containerId/versions/containerVersionId/undelete

GitHub APIs v3

GitHub針對不同動作使用了不同方法,首先是store resource,link:
# issue擁有名為locked的屬性,type為boolean
# Lock an issue
PUT /repos/:owner/:repo/issues/:number/lock
#Unlock an issue
DELETE /repos/:owner/:repo/issues/:number/lock

# Star a gist
PUT /gists/:id/star
# Unstar a gist
DELETE /gists/:id/star
# Check if a gist is starred
GET /gists/:id/star
這部分設計為store resource,但我不了解為何不做成controller resource,link:
# Merge a pull request (Merge Button)
PUT /repos/:owner/:repo/pulls/:number/merge
這裡把一筆merge當collection resource,所以是對merges做新增,link
# Perform a merge
POST /repos/:owner/:repo/merges

Box API

這裡的用法比較奇怪,因為lock也不是file的一個屬性,link:

# Lock 
PUT /files/file_id
{"lock": { "type": "lock","expires_at": "2015-12-12T10:55:30-08:00","is_download_prevented": false}}
# Unlock
{"lock": null}
使用controller resource:
# Copy a file
POST https://api.box.com/2.0/files/file_id/copy
# Used to create a copy of a folder in another folder. The original version of the folder will not be altered.
POST https://api.box.com/2.0/folders/folder_id/copy
第一次看到OPTIONS的用法,用來檢查資源是否可存取,
# Preflight Check, The Pre-flight check API will verify that a file will be accepted by Box before you send all the bytes over the wire.
OPTIONS https://api.box.com/2.0/files/content
以lock與unlock來說,我會選擇設計為store resource:
# Lock 
PUT /files/file_id/lock
# Unlock
DELETE /files/file_id/lock

留言

這個網誌中的熱門文章

PostgreSQL - Unattended installation on windows

Introduction 要將別人軟體包裝到自己軟體中,不可或缺的東西就是Unattended installation。以Unattended installation來說,我們可以選擇透過Installer的silent mode安裝,也可以透過把目標軟體做成portable的版本。本篇文章分享這兩種方法,教導大家如何將PostgreSQL透過Unattended installation方式安裝到目標系統成為service。 Note. 本篇以PostgreSQL 10.7為例。 Install with installer Tips 安裝程式或反安裝程式的參數,除了可以直接上官網搜尋Installation User Guide以外,也可以直接使用help參數查詢: postgresql- 10.7 - 2 -windows-x64.exe --help Windows安裝程式主要有EnterpriseDB與BigSQL兩種。BigSQL版本安裝元件是透過網路下載且支援參數不如EnterpriseDB版本多,以我們需求來說,我們傾向於使用EnterpriseDB版本。接下來分享給大家安裝與反安裝方法。 Installation @ echo off set INSTALL_DIR =C:\postgres10 set INSTALLER =postgresql- 10.7 - 2 -windows-x64.exe   rem options for installation set SSMDB_SERVICE =postgresql- 10 set MODE =--unattendedmodeui none --mode unattended   set DB_PASSWD =--superpassword postgres set DB_PORT =--serverport 5432   set SERVICE_NAME =--servicename % SSMDB_SERVICE %   set PREFIX =--prefix "%INSTALL_DIR%" set DATA_DIR =--datadir "%INSTALL_DIR%\data"   set OPTIONS =

How to install RIDE on Windows?

Introduction 多年沒在Windows上開發RobotFramework,趁著這次整理一下RIDE安裝方法。 目前RIDE最新版本與Python對應版本如下: (3.6 < python <= 3.11) Install current released version (2.0.8.1) with: pip install -U robotframework-ride 安裝Python 直接到Python官網找尋最新的3.11版本,我使用3.11.9: link 。安裝就是一直下一步而已。 安裝wxPython 每次安裝RIDE最困難的都是wxPython。看了一下 官網 描述,我就姑且相信一下: 接著進入下 載頁面 就有安裝教學。基本上就是到Python目錄下的Scripts直接執行以下command: pip install -U wxPython 安裝RIDE 接著就如RIDE官網所說,執行以下command: pip install -U robotframework-ride 啟動RIDE 直接在相同目錄下執行ride就可以啟動了,你也可以直接在桌面建ride連結,加快下次啟動時間。 沒想到這次這麼順利就安裝完成了。因為我是使用java去啟動robot framework,就不特別講要怎麼使用pip安裝robot framework了。

Hello World!

即將要搬家,因此舊網頁內容將慢慢轉移至Blogger。 如果要存取舊網頁,可以使用以下連結: https://wiki.tonylin.idv.tw/dokuwiki/doku.php