Question

我正在创建一个主要在内部使用的API - 但我将以这样的方式创建它，以便将来创建RESTful接口将很容易。我一直在迷恋所有微小的细节，除了为基本的crud操作命名的确切方法之外，我已经确定了所有内容。在我看来，我有几个选择：

创建，添加，新建，发布
阅读，获取
更新，编辑，添加
删除，删除

可能还有更多......

我倾向于“添加，获取，编辑，删除”。 RESTful接口将是内部API的辅助接口，因此将它们与相应的HTTP方法一起命名可能没有多大意义（标准开发：“为什么编辑方法称为'put'？谁设计了这个呢？ “）。

而且我很清楚生活中有更重要的事情！ ;）

Answer 1

我更喜欢使用HTTP方法名称，我发现最终其他开发人员更容易阅读。

此策略也是ASP.Net MVC4 Web API中的默认策略：

public class SomeRestController : ApiController 
{
    public IEnumerable<Entity> Get() { ... }

    public Entity Get(int id) { ... }

    public HttpResponseMessage Post(Entity e) { ... }

    public void Put(int id, Company c)  { ... }

    public HttpResponseMessage Delete(int id) { ... }
}

但是，如果您正在设计的应用程序与API完全分离，则可能应将方法命名为类似集合（get，add，remove等）

最佳实践：CRUD操作的首选术语是什么？

1 个答案: