動詞の例は、そのメソッドに関連するよく使う動詞の一部です。例に挙げた動詞だけに限定する必要はありません。
エンドポイントのタイトルでは、動詞の原形を使います。例: “Create a namespace.”
エンドポイントの説明では、動詞の現在形を使います。例: “Creates a namespace under the given title.”
タイトルと説明で、メソッドの種類を動詞として使ってもかまいません。たとえばメソッドが GET で、説明に “Gets embed code” と書くのは問題ありません。
| メソッド | 用途 | 動詞の例 |
|---|---|---|
GET |
リソースを取得する | Gets, Lists, Returns, Downloads |
POST |
リソースを作成する | Creates, Watches, Inserts, Adds |
PUT |
既存リソースを更新または作成する | Updates, Modifies, Adds |
PATCH |
既存リソースを部分的に変更する | Updates, Edits, Changes |
DELETE |
リソースを削除する | Deletes, Removes, Cancels |