跳到主要內容

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

留言

這個網誌中的熱門文章

解決RobotFramework從3.1.2升級到3.2.2之後,Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護,我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情,主要先把明確的runtime語法錯誤與deprecate item處理好,這部分內容可以參考: link 。 直到最近才發現,透過SeleniumLibrary執行Choose File去上傳檔案的動作,會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法,我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住,有些測試案例是可以執行的,但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作,因為我使用 Remote Selenium ,所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現,在3.2.2的最後一個TCP封包,比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容,還有HTTP Content-Length的計算,我都確認過沒有問題。 最後發現問題是出在socket API的使用上,就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料,但沒處理到尚未送完的資料內容,而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方,在他們出新的版本之前,我是將改完的_socket.py放在我們自己的Lib底下,好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)

Show NIC selection when setting the network command with the device option

 Problem  在answer file中設定網卡名稱後,安裝時會停在以下畫面: 所使用的command參數如下: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 Diagnostic Result 這樣的參數,以前試驗過是可以安裝完成的。因此在發生這個問題後,我檢查了它的debug console: 從console得知,eth1可能是沒有連接網路線或者是網路太慢而導致的問題。後來和Ivy再三確認,有問題的是有接網路線的網卡,且問題是發生在activate階段: Solution 我想既然有retry應該就有次數或者timeout限制,因此發現在Anaconda的說明文件中( link ),有提到dhcptimeout這個boot參數。看了一些人的使用範例,應該是可以直接串在isolinux.cfg中,如下: default linux ksdevice = link ip =dhcp ks =cdrom: / ks.cfg dhcptimeout = 90 然而我在RHEL/CentOS 6.7與6.8試驗後都無效。 因此我就拿了顯示的錯誤字串,問問Google大師,想找一下Anaconda source code來看一下。最後找到別人根據Anaconda code修改的版本: link ,關鍵在於setupIfaceStruct函式中的setupIfaceStruct與readNetConfig: setupIfaceStruct: 會在dhcp時設定dhcptimeout。 readNetConfig: 在writeEnabledNetInfo將timeout寫入dhclient config中;在wait_for_iface_activation內會根據timeout做retry。 再來從log與code可以得知,它讀取的檔案是answer file而不是boot command line。因此我接下來的測試,就是在answer file的network command上加入dhcptimeout: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 --...

第一次寫MIB就上手

SNMP(Simple Network Management Protocol)是用來管理網路設備的一種Protocol,我對它的認識也是從工作接觸開始。雖說是管理網路設備,但是主機、電源供應器、RAID等也都可以透過它來做管理。如果你做了一個應用程式,當然所有的操作也都可以透過SNMP來完成,不過可能會很痛苦。前陣子遇到一個學弟,它告訴我說:「我可能不會想寫程式。」為什麼? 因為這是他痛苦的根源。 在這篇文章中,不是要告訴你SNMP是什麼,會看這篇文章的大哥們,應該已經對SNMP有些認識了。 是的!主題是MIB(Management information base)! 對於一個3th-party的SNMP oid,有MIB可以幫助你去了解它所提供的資訊是什麼,且可以對它做什麼操作。最近我運氣很好剛好做到關於修改MIB的工作,也讓我順便了解一下它的語法,接下來我要交給大家MIB的基礎認識。 smidump 我並非使用什麼高強的Editor去編寫MIB,我僅透過Nodepad++編輯和smidump編譯而已。smidump是Kay教我使用的一個將MIB module轉成樹狀結構或oid列表的工具,唯一的缺點是不會告訴你哪一行打錯。當然有錢直接買編輯樹狀結構的工具就可以不需要了解語法了! 安裝 在Ubuntu上可先輸入smidump確認是否安裝,如果沒安裝可透過apt-get install libsmi2ldbl安裝。(CentOS可以透過yum install libsmi) root@tonylin:~/multi-boot-server# smidump The program 'smidump' is currently not installed. You can install it by typing: apt-get install libsmi2ldbl 使用 透過下面兩行指令,就可以將mib file產生出對應的tree與oid列表的檔案。也可以透過這個結果確認MIB是不是你想要的。 smidump -f tree example1.mib > xtree.txt smidump -f identifiers example1.mib > xiden.txt 如果有參考其它檔案要加上p的參數: smidum...