Question

我正在尝试找出构建API的最佳方法;我们在标准REST结构中设置了评论（列表一，列出所有，创建，更新等）。如果它不完全适合的例子是：每个评论可以链接到一个或多个其他类型，例如事件，地点或事情。

我的想法是网址将是： / event / reviews /（或者反之亦然/ review / event /） /位置/评论/ /事情/评论/

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

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

Answer 1

首先＆＃34; Best＆＃34;解决方案是一个相当主观的术语。我通常的目标是干燥，可重复使用，高性能的解决方案，促进最小的努力，摩擦和chattiness，而其他人可能会定义＆＃34; Best＆＃34;它是如何紧密遵循REST原则的。因此，根据目标的不同，您将获得不同的响应。我只能提供如何处理它。

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

分离

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

使用逻辑/分层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操作。

Physical Project Structure

理想情况下，根级 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.ServiceModel DTO保存在各自独立的实现和无依赖dll中，您可以自由地在任何.NET客户端项目中共享此dll - 您就是可以与任何通用C# Service Clients一起使用，以提供端到端类型的API，而无需任何代码。

更新

此建议的项目结构现已包含在所有ServiceStackVS' VS.NET Templates。
Simple Customer REST Example有一个小型的自包含，真实世界的例子，用于使用RDBMS创建简单的REST服务。

Answer 2

不确定它是否对您的场景/理解有所帮助，但我发现此演示文稿很有用：

Designing a Beautiful REST+JSON API

推荐的ServiceStack API结构

2 个答案:

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

使用逻辑/分层Url结构

实施

Physical Project Structure

更新