传统的基于 RPC 的 Web 服务将 API 设计作为单个集合的集合方法调用,导致重复和有限的灵活性。相比之下,ServiceStack 提倡基于消息的设计原则,强调简洁、通用和多功能的服务。
设计 ServiceStack 请求 DTO 时,请考虑以下事项:
作为示例,让我们重构提供的预订限额services:
[Route("/bookinglimits/{Id}")] public class GetBookingLimit : IReturn<BookingLimit> { public int Id { get; set; } } public class BookingLimit { // Properties (omitted for brevity) } [Route("/bookinglimits/search")] public class FindBookingLimits : IReturn<List<BookingLimit>> { public DateTime BookedAfter { get; set; } }
从响应中删除的功能包括 ResponseStatus,因为它可以使用通用 ErrorResponse DTO 进行处理。此外,GetBookingLimits 中的 Date 属性已替换为更具体的 BookedAfter 属性。
服务实现现在如下所示:
[Authenticate] public class BookingLimitService : AppServiceBase { public BookingLimit Get(GetBookingLimit request) { ... } public List<BookingLimit> Get(FindBookingLimits request) { ... } }
身份验证已已作为服务类上的单个属性应用。
验证应该分层且非侵入性,易于添加和维护。以下验证器可用于 CreateBooking:
public class CreateBookingValidator : AbstractValidator<CreateBooking> { public CreateBookingValidator() { // Validation rules } }
请记住,使用 C# 异常或 Fluent Validation 之间的选择取决于操作的副作用。
通过采用基于消息的设计方法,ServiceStack 允许您创建更简洁、可重用且灵活的 API。
以上是ServiceStack 基于消息的设计如何改进 Web 服务的请求 DTO 设计?的详细内容。更多信息请关注PHP中文网其他相关文章!