c# - ASP.NET Web API 中的多个 PUT 方法

Question

我有一个 Controller Groups 具有以下操作:

public GroupModel Get(int ID)

public GroupModel Post(CreateGroupModel model)

public void Put(PublicUpdateGroupModel model)

public void PutAddContacts(UpdateContactsModel model)

public void PutRemoveContacts(UpdateContactsModel model)

public void Delete(int ID)

我想做的是使用标准的 REST 路由来调用标准的获取、发布、放置、删除方法。但如果操作名称附加到 url，则调用 PutAddContacts 和 PutRemoveContacts，例如:

GET 组/- 调用 Get 方法

POST 组/- 调用 Post 方法

PUT 组/- 调用 Put 方法

DELETE 组/- 调用 Delete 方法

PUT groups/addcontacts - 调用 PutAddContacts 方法

PUT groups/removecontacts - 调用 PutRemoveContacts 方法

是否可以设置路由来执行此操作，或者如果我想在我的 URL 中使用操作名称，我是否需要沿着 RPC 路由进行路由？

Answer 1

你现在拥有的
要使用上述方法，您需要使用 RPC。那是因为您的示例已经一半沉浸在 RPC 做事风格中。默认 WebAPI 路由鼓励 RESTful 设置，但如果您对路由进行微小改动，一切都会开始工作。例如，您可以将默认路由更改为典型的 MVC 路由:

routes.MapRoute( name    : "Default",       
                 url     : "{controller}/{action}/{id}",
                 defaults: new { controller = "Home", 
                                 action     = "Index", 
                                 id         = UrlParameter.Optional });

添加路由后，以使用 Controller 名称和操作的典型 MVC 方式调用事物。然而，从你的问题来看，我怀疑你真的想要 RESTful，而不是让它工作，所以请继续阅读......

RESTful
休息 doesn't require HTTP ，尽管两者经常一起讨论。 REST 实际上是关于每个资源都具有语义上准确的表示。当使用 HTTP 时，这意味着尊重 HTTP 语义的唯一 URI。因此，例如，使用 HTTP GET 的调用不应该修改数据，因为这违反了 HTTP 的 GET 定义并混淆了缓存等 HTTP 基础设施。

POST/PUT 与 MERGE/PATCH
我们都熟悉 GET、POST、PUT、HEAD 等 HTTP 方法。 一般，GET 用于检索，POST 用于添加，PUT 用于修改(尽管有很多争论)。然而，您有两种类型的修改:添加项目和从集合中删除项目。那么它们是 PUT 还是其他？社会hasn't quite settled关于如何做到这一点。

• 选项 1:自定义媒体类型 - HTTP 规范确实允许各种方法，是浏览器真正将我们限制在熟悉的子集中。所以你可以创建MERGE (a Roy Fielding work around) or PATCH (an oData work around)方法并定义这种新媒体类型的行为——可能一种用于添加，一种用于删除。

• 选项 2:使用 POST/PUT - 使用 PUT 添加和删除联系人。只需将 ID 列表视为一个开关(如果存在则删除，如果缺少则添加)或交替包含足够的信息以知道该怎么做。然后向客户端返回一个 HTTP 303 指示其处于陈旧状态并刷新。

• 选项 3:完整列表 - 如果您的集合大小合理，则每次要更新时您始终可以传递完整的联系人列表。这样，逻辑就是 super 简单的删除和替换。

从 RESTful 的角度来看，真正重要的是您的应用程序在所有方法中都以一致的方式运行。所以如果 MERGE 意味着添加，它应该总是意味着添加。如果您希望将一组完整的 ID 传递给 PUT，则始终传递一组完整的 ID。

Controller 设计
如果是我，我会把你的 Controller 分成多个 Controller 。一个 Controller 处理组，另一个 Controller 处理联系人(作为一个组)，第三个 Controller 处理组内的一个联系人。像...

//api/Group/
public List<GroupModel> Get()
public GroupModel Get(int ID)
public GroupModel Post(GroupModel model)  //add a group
public GroupModel Put(GroupModel model)   //update a group (see comments above)
public void Delete(int ID)


//api/GroupContacts/
public ContactsModel Get()                    //gets complete list
public void PostContacts(ContactsModel model) //pushes a COMPLETE new state
public void Delete()                          //delete entire group of contacts


//api/GroupContact/354/
public ContactModel Get(int id)             //get contact id #354
public void PostContact(ContactModel model) //add contact (overwrite if exits)
public void Delete(int id)                  //delete contact if exists

如果您希望您的 URL 出现嵌套(例如:/api/Group/Contacts、/api/Group/Contact)，您可以查看 this other post I wrote .恕我直言，asp.net 的路由需要调整以支持嵌套更容易一些......但这是一个不同的问题;-)