c# - REST API URL 模式

Question

我目前正在设计 REST API 接口(interface)，并尝试确定构建调用的最佳方式。

我提供在系统中创建记录的功能。但是，可以使用两组不同的数据来创建记录，具体取决于调用数据的系统。

我正在考虑提供格式为

的网址

/api/create/auto
/api/create/manual

并使用相同的函数(自动/手动将是路由参数)进行处理，主体包含适当的数据。但是我想知道是否提供格式为 url

/api/createauto
/api/createmanual

并使用两个单独的函数来处理是更好的使用格式。涉及的处理相当简单，我只需获取传入数据并将其传递给数据库中的两个存储过程之一来完成工作。如果我采用第一种方式，我必须添加验证以确保仅传递正确的值。

Answer 1

REST Api 最佳实践实际上指出端点应该是名词而不是动词。在最佳实践情况下，端点应该是

POST /api/object_name

然后您可以通过数据正文中的字段指定自动还是手动。否则，如果您确实想通过 URL 指定自动或手动，则可以使用查询参数，尽管我认为这实际上并不合理。

POST /api/object_name?type=auto

你最好的选择，可能会将类型添加到 json 正文中(假设你使用的是 json)。所以像

{"type":"auto","data":{data json object}}