ServiceStack DTO的命名约定

时间:2014-02-20 00:31:36

标签: servicestack

我知道这已经在某种程度上被要求了 - 这是一个相当主观的问题。我正在试图找出一组服务的最佳命名约定,我们将从WCF移植到ServiceStack。我已经阅读了很多ServiceStack文档和示例 - 我觉得我对整体结构有很好的理解。我想要解决的是我的请求和响应DTO的最佳命名约定。

让我举几个例子。这是我的请求dto,因为我目前已将其命名为。

[Route("/blast/emailblast", "POST")]
public class CreateEmailBlast : IReturn<CreateCreateEmailBlastResponse>  
{
    public Guid SenderProfileId { get; set; }
    public Guid TemplateId { get; set; }
    public string CallListName { get; set; }
    public string CallListCategory { get; set; }    
}

public class CreateEmailBlastResponse : ICreateEmailBlastResponse
{
    public string ResponseMessage { get; set; }
}

所以我采用的命名是dto的前缀,帖子为“Create”,Get为“Get”等等......使用EmailBlast和EmailBlastResponse会更明智吗?只是想知道是否有人对这两种不同的命名方法有一些意见。

1 个答案:

答案 0 :(得分:0)

我认为仅使用EmailBlast会更明智。因为,http动词可以识别将要发生的事情。

如果您正在研究如何设计出良好的API。 (通用,不具体用于SS)。有infoq的精彩视频。我不记得最重要的名字了。

但该演示文稿的主旨是,尝试将API视为面向用户的html页面。用户端需要什么。我可以再去一点,在决定页面后定义模型。具体而言,需要元数据。

意思是,有一个EmailBlast模型,如何判断创建。因此,我将使用http post动词而不是CreateEmailBlast模型。在这里,我想举一个简单的例子。

就个人而言,我会尽量避免使用匈牙利语表示变量以及模型。

如果我理解你的问题,请告诉我,如果您需要我的最终细节,请告诉我。