Qual é o argumento para substantivos singulares na nomeação de recursos da API RESTful?


12

Entendo que, ao nomear URIs RESTful, geralmente é aceito o uso de plurais para representar coleções de recursos. Estou curioso quanto ao argumento para usar substantivos singulares.


talvez porque nem tudo é uma coleção?
usar o seguinte comando

Não é aí que um recurso único entra em cena?
Charness

Respostas:


12

Alguns recursos contêm apenas um único item. Bons exemplos seriam tudo para o qual você não precisa de um ID para descobrir quais dados renderizar. Muito comum, por exemplo, seria o recurso Login. Você tem (na visão de usuários e navegadores) apenas um único login. Você pode criá-lo, destruí-lo, mas não terá uma ação de índice com vários logins para escolher.

Exemplos semelhantes seriam algumas páginas estáticas, como informações da empresa, impressões, formulários de contato e coisas semelhantes que exibem apenas um único item ou permitem apenas uma única ação de criação.

Pode ser uma questão de discussão se o uso de substantivos singulares realmente acrescentar muito à legibilidade do código.


5

Porque:

  1. Regras plurais em inglês, como "cerejas", não são a melhor coisa a se pensar durante o desenvolvimento da API, principalmente quando o inglês não é sua língua materna.
  2. Às vezes, você deseja gerar um ponto de extremidade a partir do modelo, que geralmente é singular. Não joga bem com o que foi dito acima.
  3. O argumento "geralmente você começa a consultar por um Get para exibir uma lista" não se refere a nenhum caso de uso real. E você acabará consultando itens únicos tanto quanto e até mais do que uma lista de itens.
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.