Semantics
Desde já deixo claro que não sou nenhum especialista no assunto, como informado no “about”, sou apenas um estudante de Análise e Desenvolvimento de Sistemas buscando sempre se aperfeiçoar.
Esta SDK é um laborário, mas para além disso, também é uma ferramenta que levo a sério, dito isso, falarei um pouco sobre a padronização e samântica que apliquei em todas as funções da aplicação.
Create, Delete, Update And More
Observem no IntelliSense que quando digitado “cre”, automaticamente surgem todos os métodos “create…” disponível na sdk.
O mesmo acontece com todos os outros métodos, segue abaixo exemplos.
IntelliSense and Highlights
Caso digite “ById”, o IntelliSense vai exibir todos os métodos que contenham “ID”, ou seja, “get by id”, “update by id”, além disso, me preocupei também com os sentidos quantitativos.
Por exemplo: “get one” para listar um ou “get all” para listar todos.
Pensando nos retornos dos métodos, caso você chame “get one”, receberá sempre um objeto, caso chame “get all” receberá sempre um array, independentemente da quantidade desse array.
Ainda falta alguns ajustes relacionado a essa padronização e o projeto está aberto a pull requests.
