67

我正在尝试找出构建 API 的最佳方式；我们有我们在标准 REST 结构中设置的评论（列出一个、列出所有、创建、更新等）。不太适合示例的地方是：每条评论都可以链接到一个或多个其他类型，例如事件、位置或事物。

我的想法是网址将遵循以下内容：/event/reviews/（或与此相反，例如/reviews/event/）/location/reviews//thing/reviews/

然而，我可以看到的问题是这些中的每一个的“GET”应该返回父对象，即一个事件。

那么使用 ServiceStack，处理这种情况的最佳方法是什么？是为每个数据请求创建一个自定义服务，而不是滥用开箱即用的 REST 设置，还是我错过了一些更基本的东西？

4

1 回答 1

140

首先，“最佳”解决方案是一个相当主观的术语。我通常会针对 DRY、可重用、高性能的解决方案，以促进最少的努力、摩擦和闲聊，而其他人可能会定义“最佳”，即它在多大程度上遵循 REST 原则。因此，您将根据目标得到不同的响应。我只能提供我将如何处理它。

ServiceStack 服务实现与其自定义路由解耦

要记住的一件事是，您在 ServiceStack 中定义和设计服务的方式与公开它们的方式完全解耦，因为您可以在任何自定义路由下公开您的服务。ServiceStack 鼓励基于消息的设计，因此您应该为每个操作提供不同的消息。

使用逻辑/分层 Url 结构

我将使用一个逻辑 Url 结构，旨在表示名词的标识符，它是分层结构的，即父路径对您的资源进行分类并为其提供有意义的上下文。因此，在这种情况下，如果您想公开事件和评论，我倾向于使用以下 url 结构：

/events             //all events
/events/1           //event #1
/events/1/reviews   //event #1 reviews

这些资源标识符中的每一个都可以应用任何 HTTP 动词

执行

对于实现，我通常遵循基于消息的设计，并根据响应类型和调用上下文对所有相关操作进行分组。为此，我会做类似的事情：

[Route("/events", "GET")]
[Route("/events/category/{Category}", "GET")] //*Optional top-level views
public class SearchEvents : IReturn<SearchEventsResponse>
{
   //Optional resultset filters, e.g. ?Category=Tech&Query=servicestack
   public string Category { get; set; } 
   public string Query { get; set; }
}

[Route("/events", "POST")]
public class CreateEvent : IReturn<Event>
{
   public string Name { get; set; }
   public DateTime StartDate { get; set; }
}

[Route("/events/{Id}", "GET")]
[Route("/events/code/{EventCode}", "GET")] //*Optional
public class GetEvent : IReturn<Event>
{
   public int Id { get; set; }
   public string EventCode { get; set; } //Alternative way to fetch an Event
}

[Route("/events/{Id}", "PUT")]
public class UpdateEvent : IReturn<Event>
{
   public int Id { get; set; }
   public string Name { get; set; }
   public DateTime StartDate { get; set; }
}

并遵循类似的活动评论模式

[Route("/events/{EventId}/reviews", "GET")]
public class GetEventReviews : IReturn<GetEventReviewsResponse>
{
   public int EventId { get; set; }
}

[Route("/events/{EventId}/reviews/{Id}", "GET")]
public class GetEventReview : IReturn<EventReview>
{
   public int EventId { get; set; }
   public int Id { get; set; }
}

[Route("/events/{EventId}/reviews", "POST")]
public class CreateEventReview : IReturn<EventReview>
{
   public int EventId { get; set; }
   public string Comments { get; set; }
}

基于这些消息，实现应该是相当直接的，这些消息（取决于代码库大小）我将组织在 2 个EventsService和EventReviewsService类中。我应该注意，我自己对服务请求 DTO 名称使用复数形式，以避免与同名的数据模型发生冲突。

虽然我已经UpdateEvent和这里分开了，但如果用例允许CreateEvent，我有时会将它们合并为一个幂等操作。StoreEvent

物理项目结构

理想情况下，根级AppHost项目应保持轻量级且无需实现。尽管对于只有少量服务的小型项目，可以将所有内容都放在一个项目中，并在需要时根据需要简单地扩展您的架构。

对于大中型项目，我们建议使用下面的物理结构，出于本示例的目的，我们假设我们的应用程序称为EventMan。

项目的顺序也显示了它的依赖关系，例如顶级EventMan项目引用所有子项目，而最后一个EventMan.ServiceModel项目引用无：

- EventMan
    AppHost.cs              // ServiceStack ASP.NET Web or Console Host Project

- EventMan.ServiceInterface // Service implementations (akin to MVC Controllers)
    EventsService.cs
    EventsReviewsService.cs

- EventMan.Logic            //For larger projs: pure C# logic, data models, etc
    IGoogleCalendarGateway  //E.g of a external dependency this project could use

- EventMan.ServiceModel     //Service Request/Response DTOs and DTO types
    Events.cs               //SearchEvents, CreateEvent, GetEvent DTOs 
    EventReviews.cs         //GetEventReviews, CreateEventReview
    Types/
      Event.cs              //Event type
      EventReview.cs        //EventReview type

由于EventMan.ServiceModelDTO 保存在自己的单独实现和无依赖 dll 中，您可以按原样在任何 .NET 客户端项目中自由共享此 dll - 您可以将其与任何通用C# 服务客户端一起使用以提供结束没有任何代码生成的端到端类型化 API。

更新

于 2013-03-05T23:01:15.657 回答