Releases: ThiagoNelsi/dicio-api
v2.0.0
😎 Versão 2 na área!!!
Para utilizar a nova versão, utilize o prefixo /v2/ nos endpoints da API.
ALERTA: Algumas mudanças importantes aconteceram, algumas delas podem causar incompatibilidades com a versão 1! Por isso, antes de migrar para a nova versão, leia as Breaking Changes a seguir, em que essas incompatibilidades são explicadas.
⚠️ Breaking Changes
- A partir da versão 2.0.0, o atributo
class
, retornado pela rota de significados, foi alterado parapartOfSpeech
. Isso se deve ao fato da palavraclass
ser reservada no JavaScript/TypeScript, o que causa alguns transtornos durante a utilização da API. Além disso, a tradução correta de classe gramatical para o inglês é part of speech e não class. - A rota de sílabas passa a retornar um array com as sílabas ao invés dos atributos
syllablesText
esyllablesCount
. Veja a comparação entre o retorno da versão 1 e da versão 2 para a palavra livro:
v1
{
"syllablesText": "li-vro",
"syllablesCount": 2
}
v2
[
"li",
"vro"
]
📖 Rotas em português!
Uma API da língua portuguesa precisava adequar-se mais ao seu contexto, não é? Por isso, na versão 2, a API passa a suportar rotas em português (as rotas em inglês foram mantidas). Agora as rotas passam a ser:
Significados:
- /v2/[palavra]
- /v2/significados/[palavra]
- /v2/meanigns/[palavra]
Sinônimos:
- /v2/sinonimos/[palavra]
- /v2/synonyms/[palavra]
Sílabas:
- /v2/silabas/[palavra]
- /v2/syllables/[palavra]
Frases:
- /v2/frases/[palavra]
- /v2/sentences/[palavra]
🚀 Melhorias de performance
A versão 2.0 trouxe melhorias de performance consideráveis, pois prioriza buscar dados de um banco de dados MongoDB ao invés de fazer scrapping do Dicio a cada nova requisição.
Na nova versão, quando alguma palavra é requisitada, o sistema busca as informaçãoes dela no MongoDB e as retorna ao cliente. Caso a palavra não esteja armazenada no banco de dados, o sistema faz scrapping do Dicio, armazena as informções no banco e retorna a resposta ao cliente. Dessa forma, o banco é alimentado de forma incremental conforme novas palavras são requisitada pelos clientes.
v1.3.2
v1.3.2 - Stable Version 📚
🚀 Melhorias de código
- Migração para TypeScript, visando melhor qualidade de código.
- Refatoração para reduzir duplicação de código
🐞Correção de bugs
- Correção do bug de acentuações: quando uma request era feita para a API com uma palavra acentuada, como
metrô
, a API retornava resuldados baseados na palavra sem acento, ou seja,metro
. Nesta nova release esse bug foi corrigido. - Correção do bug de hífen: agora a API passa a aceitar palavras com hífen.
Com o lançamento dessa release (em que todos os bugs conhecidos foram corrigidos), o foco é agora trabalhar na versão 2, que está sendo planejada para trazer muito mais velocidade nas respostas, confiabilidade e disponibilidade da API. Além disso, a intenção também é converter as rotas da API para a língua portuguesa, visto que isso se adequa melhor ao contexto da aplicação.
A nova versão está em desenvolvimento na branchv2