C# 推荐的ServiceStack API结构

我正在努力找出构造API的最佳方法；我们在标准REST结构中设置了一些评论（列表一、列表全部、创建、更新等）。不太适合的例子是：每个评论可以链接到一个或多个其他类型，例如事件、地点或事物

我的想法是URL应该是： /事件/评论/（或与此相反的，例如/评论/事件/） /地点/评论/ /事件/评论/

但是，我可以看到的问题是，每个对象的“GET”都应该返回父对象，即事件

那么，使用ServiceStack，处理此场景的最佳方法是什么？是为每个数据请求创建自定义服务，而不是滥用现成的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; }
}

有了

EventMan.ServiceModel

DTO保存在各自独立的实现和无依赖关系的dll中，您可以在任何.NET客户端项目中自由地共享此dll—您可以将其与任何泛型一起使用，以提供端到端类型的API，而无需任何代码生成

---

更新

• 建议的项目结构现在包含在所有项目中

• 有一个使用RDBMS创建简单REST服务的自包含的真实示例

---

@robrtc是的，它们都包含impl-logic，logic项目适用于大型解决方案，在这些解决方案中，您可以像存储库一样保留可共享逻辑（如果有）。但我仍然可以访问其他地方不共享/不需要的服务中的临时数据库。@mythz我已经读到，为api创建一个“版本1”文件夹结构是一个好主意，以防您将其公开…因此这里将成为/api/v1/events/…您对此有何想法？将其与您的建议相结合的最佳方式是什么？@AaronFischer如果您用属性注释DTO，那么它只需要

ServiceStack.Interfaces.dll

上的一个dep，这是一个无impl.dll。目前，SS.Interfaces仍在SS.Common NuGet pkg中，在下一个NuGet中，它将位于自己的细粒度pkg中。但实际上这并不重要，因为.NET客户端需要

SS.Common

才能使用类型化的.NET客户端。@mythz此答案已成为servicestack api设计的常用资源。但是，请求消息类缺少

IReturn

标记，我认为这仍然是推荐的方法？你介意把它们添加到你的答案中，让它更全面吗？它有助于澄清响应消息设计在

[RequestName]响应

包装消息与文本

列表

消息之间的选择。@mythz“类型”文件夹中的类是响应类型吗？如果是，这是否意味着这些属性在ServiceModel项目中的响应类型和根级别类之间是重复的？如果这些不是响应类型，服务项目如何使用它们？我主要是想确定“Types”文件夹除了包含供客户端使用的DTO之外还有什么用途。

[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; }
}

- 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