动词示例是与某种方法相关联的少数常用动词,但您不应受到限制并仅使用示例中的动词。
撰写端点标题时,请使用动词的字面原形。例如,“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 |