Asp.NET WebApi 基于约定的方法 Url/Route 查询

我不确定基于 ASP.NET WebAPI 约定的休息服务的“最佳实践”前进方向，该服务需要返回资源的“子属性”。

eg:

UsersController

public User Get(int id) { ... } //returns named user via /api/v1/Users/23

但如果我想返回给定的用户角色集合，我想我想要一个 url/api/v1/Users/23/Roles

如果您使用我的 api 您认为这是可以接受的吗？

如果可以接受，我的routeTemplate和方法签名会是什么样子（抱歉，如果这是显而易见的 - 我今天真的很困惑）

我能找到的所有 Web api 示例都太简单了，只使用 DELETE、PUT、POST 和两个 GET - 似乎没有一个涵盖子属性（如上所述）或部分响应之类的内容/api/v1/Users/23?fields=id,name- 如果有人知道一个很好的例子那就太棒了。

非常感谢

Roles

角色看起来是一个非常明智的子资源。

假设您想要使用 http 动词列出和删除用户的角色...那么您可以使用两个控制器，一个用于用户，另一个用于角色。您的路线将如下所示：

config.Routes.MapHttpRoute(
            name: "UserApi",
            routeTemplate: "api/v1/Users/{userId}/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/v1/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

然后，您的角色控制器将具有以下方法：

public class RolesController : ApiController
{
    // GET api/v1/users/1/roles
    public IEnumerable<Role> Get(int userId)
    {
        //
    }

    // GET api/v1/users/1/roles/1
    public IEnumerable<Role> Get(int userId, int id)
    {
        //
    }

}

角色作为用户的部分响应

对于请求使用什么格式和标准：

apigee 在其网站上制作了一本免费电子书，其中提出了设计建议以及对现有 API 的观察。

他们描述了来自 LinkedIn、Facebook 和 Google 的部分响应示例。他们的一篇博客对此进行了介绍here http://blog.apigee.com/detail/restful_api_design_can_your_api_give_developers_just_the_information在他们的书中here http://blog.apigee.com/detail/announcement_new_ebook_on_web_api_design.

如何使用 WebApi ASP.NET

假设使用 JSON 作为内容类型，那么之前已经问过类似的问题ASP.NET Web API部分响应Json序列化 https://stackoverflow.com/questions/13606675/asp-net-web-api-partial-response-json-serialization，简而言之，您需要将“?Fields=”或类似的查询参数传递到自定义中ContractResolver.