[Lone Star PHP 2015] API Pain Points | 程式設計

[Lone Star PHP 2015] API Pain Points (speakerdeck.com)

1 則討論 afutseng 張貼於 9 years ago

IngramChen 積分 4

嘛... 投影片內容很多，不過有一點是單複數命名：

/person/alice
/people/alice
/user/alice
/users/alice

有很多種變型，每種都有人用，不過我的個人心得是 Rest API 盡可能用 單數 吧。API 要簡單，容易聯想，不容易打錯。英文單字有很多可數、不可數之分，而且複數的結尾規則也不定，什麼 s/es/ies，還有奇怪的特例像是 data vs datum 。這些變型只是來困擾 API 使用者而已，沒有任何好處 (英文語意比較合理嗎？但 URL 本來就不是完整的句子，拘泥這個幹嘛)。

用單數型就通通沒煩惱，規則只有一種，不用擔心拼錯什麼的。

回應 9 years ago

Kmark 語法說明

Kmark 是一個類似 Markdown 語法的格式，以下為提供的功能:

種類	語法	呈現
斜體	兩邊加單星	兩邊加單星
粗體	兩邊加雙星	兩邊加雙星
刪除線	~~兩邊加雙曲號~~	~~兩邊加雙曲號~~
引用	> 左邊加個大於符號	左邊加個大於符號
列表	* 可用星號 * 也可以 - 減號 * 數字加點也可以	可用星號也可以 - 減號數字加點也可以
固定寬字	`abcdefghijk` 兩邊用倒引號包住	`abcdefghijk`
編碼區塊	``` function abc() ``` 上下都用三個倒引號包住	`function abc()`
連結	[這是連結][1] [1]: http://example.com 連結第一部份是文字，先用中括號包住，後面再加上 [編號]。第二部份是連結本身，放在文末，開頭是 [編號]: http	這是連結1 1 http://example.com

Kmark 語法說明

Kmark 是一個類似 Markdown 語法的格式，以下為提供的功能:

種類	語法	呈現
斜體	兩邊加單星	兩邊加單星
粗體	兩邊加雙星	兩邊加雙星
刪除線	~~兩邊加雙曲號~~	~~兩邊加雙曲號~~
引用	> 左邊加個大於符號	左邊加個大於符號
列表	* 可用星號 * 也可以 - 減號 * 數字加點也可以	可用星號也可以 - 減號數字加點也可以
固定寬字	`abcdefghijk` 兩邊用倒引號包住	`abcdefghijk`
編碼區塊	``` function abc() ``` 上下都用三個倒引號包住	`function abc()`
連結	[這是連結][1] [1]: http://example.com 連結第一部份是文字，先用中括號包住，後面再加上 [編號]。第二部份是連結本身，放在文末，開頭是 [編號]: http	這是連結1 1 http://example.com