I am software developer based in Tallinn Estonia. While learning the estonian language I figured that there is no publicly available API for the language dictionary itself. The Estonian Language Institute provides a language portal called Sonaveeb but no way to programmatically access the dictionary content.
SONAPI is an API wrapper around www.sonaveeb.ee and my side project to stay fit and get a deeper understanding of NodeJS, Typescript, design patterns and architectural concepts. This project is built with my interpretation of an API in a Hexagonal Architecture context. (Also called Ports & Adapters Architecture).
You can find a live example on https://www.sonapi.ee/ or just simply call https://api.sonapi.ee/v1/{word} with whatever tool you like
In order to run it locally you can either use Docker with Docker Compose or run it in a local NodeJS environment.
git clone https://github.com/BenediktGeiger/sonad-api.git
cd sonad-api
cp .env.docker .env
docker-compose up --build
| URL | Information |
|---|---|
| http://localhost:8083/v1/{word} | API Endpoint |
| http://localhost:9090/ | Prometheus instance to collect NodeJS and API metrics. |
| http://localhost:3000/ | Grafana Dashboard |
git clone https://github.com/BenediktGeiger/sonad-api.git
cd sonad-api
cp .env.local .env
npm install
npm run dev
| URL | Information |
|---|---|
| http://localhost:8083/v1/{word} | API Endpoint |
In order to enable rate-limiting and caching add a redis connection string to the REDIS environment variable.
DICTIONARY="sonaveeb"
LOGGER="winston"
PORT=8083
REDIS="127.0.0.1:6379"
