Рекомендации: какая терминология является предпочтительной для операций CRUD? - PullRequest
Новая
       7

Рекомендации: какая терминология является предпочтительной для операций CRUD?

0 голосов
/ 09 марта 2012

Я создаю API, который в основном будет использоваться для внутренних целей, но я собираюсь создать его таким образом, чтобы в будущем создать интерфейс RESTful было легко.Я зацикливался на всех крошечных деталях, и у меня все пригвождено, кроме точного наименования методов для базовых операций типа crud.На мой взгляд, у меня есть несколько вариантов:

  1. Создать, Добавить, Новый, Опубликовать
  2. Читать, Получить
  3. Обновить, Изменить, Положить
  4. Удалить, Удалить

Возможно, есть еще ...

Я склоняюсь к «добавить, получить, редактировать, удалить».Интерфейс RESTful будет вторичным по отношению к внутреннему API, поэтому присвоение им имен вместе с соответствующими методами HTTP, вероятно, не имеет особого смысла (Standard Dev: «Почему метод редактирования называется« put »?").

И я прекрасно понимаю, что в жизни есть гораздо более важные вещи!;)

1 Ответ

1 голос
/ 09 марта 2012

Я предпочитаю использовать имена методов 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, вероятно, вы должны назвать методы как коллекционные (получить, добавить, удалить и т. Д.)

...