rest - 在 RESTful URL 中使用动词和形容词的替代方法-6ren

rest - 在 RESTful URL 中使用动词和形容词的替代方法

转载作者：行者123 更新时间：2023-12-05 08:23:28

25

4

我想向我的 REST API 添加操作，以在不同“商店”之间移动“资源”。

例如，假设我的资源通常通过以下 URL 访问:

/resources
/resources/{resourceId}

现在假设我想“停用”一些资源，即在概念上将其移动到另一个子文件夹。允许这样做的最直接的方法如下。

“停用”资源，即使其在/resources 下不可用。从概念上讲，它将对象“移动”到“/resources/deactivated/”子文件夹:
```
POST /resources/{resourceId}/deactivate   
```
或者:
```
POST /resources/deactivated/{resourceId}
```
获取所有停用的对象:
```
GET /resources/deactivated      
```
反转“停用”操作，即在概念上将对象从“/resources/deactivated/”子文件夹移回主文件夹(“/resources').
要么
```
POST /resources/{resourceId}/reactivate    
```
或者
```
POST /resources/deactivated/{resourceId}/restore     
```
这个 API 对我来说似乎相当直观。但它似乎违反了我在许多关于 REST API 的最佳实践文章中看到的“首选名词”规则:我使用动词和形容词而不是名词!

请注意，我可能有所有端点的参数，例如GET/resources/deactivated?createdBefore=01022017

我的 REST API 是否有更好的替代方案？ IE。更 RESTful，但不那么直观？

我可以找到关于该主题的好资源:

Confusion Between Noun vs. Verb in Rest URLs
GitHub 的动词用法(POST/gists/:id/star，DELETE/gists/:id/star):https://stackoverflow.com/a/19648997/1847482
关于需要查找“另一种对象类型”的要点:https://stackoverflow.com/a/2022938/1847482

最佳答案

首先，请记住 REST 代表Representational State Ttransfer。

一切都是关于资源及其状态。 activate、deactivate 和move 等操作都是关于用新表示替换资源的当前状态，您不需要动词在 URL 中表达此类操作。

例如，要替换资源的状态，您可以在 PUT 请求的有效负载中发送资源的新表示:

PUT /api/resources/[id]/status HTTP/1.1 Host: example.org Content-Type: application/json { "status" : "active" }
可以理解为将[id]标识的资源状态替换为请求payload中发送的状态。

然后您可以通过以下方式获取具有特定状态的资源:

GET /api/resources?status=active HTTP/1.1 Host: example.org Accept: application/json
可以理解为给我一个状态为active的所有资源的表示。

例如，要将资源移动到另一个文件夹，您可以:

PUT /api/resources/[id]/folder HTTP/1.1 Host: example.org Content-Type: application/json { "target" : "draft" }
可以理解为将[id]标识的资源文件夹替换为请求payload中发送的文件夹。

关于rest - 在 RESTful URL 中使用动词和形容词的替代方法，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/43356344/

25

4

0

文章推荐： bash - 在 bash 中合并两个 csv 文件

文章推荐： vb.net - 从 PC 获取唯一的硬件 ID

文章推荐：用于在悬停行上显示按钮的 Angular 2 表行悬停

Ruby 方法() 方法
我想了解 Ruby 方法 methods() 是如何工作的。我尝试使用“ruby 方法”在 Google 上搜索，但这不是我需要的。我也看过 ruby-doc.org，但我没有找到这种方法。
VBS教程：方法-Test 方法
Test 方法对指定的字符串执行一个正则表达式搜索，并返回一个 Boolean 值指示是否找到匹配的模式。 object.Test(string) 参数 object 必选项。总是一个
VBS教程：方法-Replace 方法
Replace 方法替换在正则表达式查找中找到的文本。 object.Replace(string1, string2) 参数 object 必选项。总是一个 RegExp 对象的名称。
VBS教程：方法-Raise 方法
Raise 方法生成运行时错误 object.Raise(number, source, description, helpfile, helpcontext) 参数 object 应为
VBS教程：方法-Execute 方法
Execute 方法对指定的字符串执行正则表达式搜索。 object.Execute(string) 参数 object 必选项。总是一个 RegExp 对象的名称。 string
VBS教程：方法-Clear 方法
Clear 方法清除 Err 对象的所有属性设置。 object.Clear object 应为 Err 对象的名称。说明在错误处理后，使用 Clear 显式地清除 Err 对象。此
VBS教程：方法-CopyFile 方法
CopyFile 方法将一个或多个文件从某位置复制到另一位置。 object.CopyFile source, destination[, overwrite] 参数 object 必选
VBS教程：方法-Copy 方法
Copy 方法将指定的文件或文件夹从某位置复制到另一位置。 object.Copy destination[, overwrite] 参数 object 必选项。应为 File 或 F
VBS教程：方法-Close 方法
Close 方法关闭打开的 TextStream 文件。 object.Close object 应为 TextStream 对象的名称。说明下面例子举例说明如何使用 Close 方
VBS教程：方法-BuildPath 方法
BuildPath 方法向现有路径后添加名称。 object.BuildPath(path, name) 参数 object 必选项。应为 FileSystemObject 对象的名称
VBS教程：方法-GetFolder 方法
GetFolder 方法返回与指定的路径中某文件夹相应的 Folder 对象。 object.GetFolder(folderspec) 参数 object 必选项。应为 FileSy
VBS教程：方法-GetFileName 方法
GetFileName 方法返回指定路径（不是指定驱动器路径部分）的最后一个文件或文件夹。 object.GetFileName(pathspec) 参数 object 必选项。应为
VBS教程：方法-GetFile 方法
GetFile 方法返回与指定路径中某文件相应的 File 对象。 object.GetFile(filespec) 参数 object 必选项。应为 FileSystemObject
VBS教程：方法-GetExtensionName 方法
GetExtensionName 方法返回字符串，该字符串包含路径最后一个组成部分的扩展名。 object.GetExtensionName(path) 参数 object 必选项。应
VBS教程：方法-GetDriveName 方法
GetDriveName 方法返回包含指定路径中驱动器名的字符串。 object.GetDriveName(path) 参数 object 必选项。应为 FileSystemObjec
VBS教程：方法-GetDrive 方法
GetDrive 方法返回与指定的路径中驱动器相对应的 Drive 对象。 object.GetDrive drivespec 参数 object 必选项。应为 FileSystemO
VBS教程：方法-GetBaseName 方法
GetBaseName 方法返回字符串，其中包含文件的基本名 (不带扩展名), 或者提供的路径说明中的文件夹。 object.GetBaseName(path) 参数 object 必
VBS教程：方法-GetAbsolutePathName 方法
GetAbsolutePathName 方法从提供的指定路径中返回完整且含义明确的路径。 object.GetAbsolutePathName(pathspec) 参数 object
VBS教程：方法-FolderExists 方法
FolderExists 方法如果指定的文件夹存在，则返回 True；否则返回 False。 object.FolderExists(folderspec) 参数 object 必选项
VBS教程：方法-FileExists 方法
FileExists 方法如果指定的文件存在返回 True；否则返回 False。 object.FileExists(filespec) 参数 object 必选项。应为 FileS

首页

博学

6Ren·AI

商城

rest - 在 RESTful URL 中使用动词和形容词的替代方法