WebService para consulta de palavras do dicionário português brasileiro.
Acessando o WebService
Para acessar o WebService, sem utilizar filtros, você deve acessar o endpoint /api/v1/words.
Exemplo de consulta de palavra aleatória:
dicionario-portugues-brasileiro-filtro.onrender.com/api/v1/words
Filtros das Palavras
A consulta das palavras aleátorias tem diversos filtros de buscas, sendo eles:
?charSize - Retorna uma palavra aleatória contendo os caracteres desejados
?maxChar - Retorna uma palavra aleatória contendo o máximo de caracteres
?minChar - Retorna uma palavra aleatória contendo o minimo de caracteres
Validação
Alguns filtros podem ser combinados com a utilização do caractere &.
Exemplo: ?minChar e ?maxChar podem ser combinados, ficando assim
dicionario-portugues-brasileiro-filtro.onrender.com/api/v1/words?minChar=2&maxChar=4
.
Dessa forma, o WebService retornará uma palavra entre 2 e 4 letras.
Mas tenha cuidado para não fazer consultas com filtros conflitantes!
Quando a consulta é feita com filtros conflitantes, ela é invalidada.
Exemplo: ?minChar maior que ?maxChar, ou utilizar
?minChar ou ?maxChar junto com ?charSize.
Nesses casos, o código de retorno da consulta será 400 (Bad Request).
Antes de acessar o WebService, certifique-se de que os filtros não irão conflitar entre si.
Deseja contribuir com esse projeto?
Acesse o link do github do Peneira e contribua!
Link do Projeto no GitHub