Francois389/Dico ↗
Created Jan 7, 2025 · View the Francois389/Dico repository page
API qui permet de récupérer des mots de la langue française
Want this for your repo?
Render a free sample of any GitHub repo in seconds.
Contributors
1
Lines of Code
126
From
Dec 12, 2024
To
Dec 24, 2024
About Francois389/Dico
Dico is a Go-based API designed to retrieve French words from an online service. The project was created to fill a gap in available APIs for querying the French language, using a word list sourced from the Petit Larousse Illustré 2007 dictionary. The API runs with a MongoDB database containerized in Docker, making it easy to deploy locally.
The API provides six main endpoints for word retrieval and analysis. Users can fetch all words starting with a specific letter, retrieve a random word by its starting letter or length, find anagrams of a given word, get multiple random words for a batch of letters, and check whether a word exists in the database. Each endpoint includes proper error handling for invalid inputs and cases where no matching words are found, returning appropriate HTTP status codes.
Setup requires cloning the repository, running Docker Compose to launch the MongoDB container, populating the database with words either manually or using a provided populate.go script, and then starting the server. The straightforward architecture makes it accessible for developers looking to integrate French word data into their applications or games.
