Os endpoints devem continuar sendo em inglês?

OpenDevUFCG / laguinho-api

Onde todos os dados, pessoas e radiação da UFCG se encontram.

MIT License

28 stars 18 forks source link

Os endpoints devem continuar sendo em inglês? #10

Closed JoseRenan closed 5 years ago

JoseRenan commented 5 years ago

Acho que o título já descreve a dúvida kkkkkk mas complementando, como a gente é focado em CC@UFCG e quer incentivar a contribuição, talvez botar tudo PTBR seja uma ideia melhor... o que acham?

JoseRenan commented 5 years ago

Ping @thayannevls @JuanBarros2

danielmitre commented 5 years ago

Eu gosto da ideia de usar APIs, de programar e principalmente de ler documentação em PT-br :+1:

[EDIT] Porém, algumas palavras podem causar um mal-entendido. Acho que rotas geralmente são um ponto fraco disso. Por exemplo:

/schedule/all faz bastante sentido.
/horario/todos faz parecer que vai retornar uma lista de TO-DO's.
/horario/all funciona, mas é meio estranho.

JuanBarros2 commented 5 years ago

Concordo com @danielmitre. Gosto da ultima abordagem e acredito que é possível estabelecer alguns padrões de código para manter a coerencia. Poderiamos adicionar um linter no repositório e colocar o travis pra rodar ele ao realizar um PR.

JuanBarros2 commented 5 years ago

Só não gosto da segunda abordagem mesmo. É o grande problema da programação, sempre somos condicionados a escrever em inglês, mas quando o contexto pede português, tiltamos :smile:

JoseRenan commented 5 years ago

Assim, por padrão, no REST os recursos tem de estar no plural e o / retornar todos, daí ao invés de /horarios/all ficaria só /horarios então nn seria muito problema

thayannevls commented 5 years ago

Concordo! Tudo ptbr