Czech Vocative API Server
Description
Public REST API for Czech Vocatives based on Minister of the Interior database
TODO
- Automate load from CSV
- Generate exports - full (CSV, JSON, SQLite)
- Improvements...
Build
Download dependencies
dep ensureMake
make
# or cross-compile for Linux amd64
make linux64
# or docker image
make dockerRun
Configuration ENV variables
Variables and default values
VOCATIVE_LISTEN_IP=0.0.0.0
VOCATIVE_LISTEN_PORT=8080
VOCATIVE_DB_HOSTNAME=localhost
VOCATIVE_DB_PORT=5432
VOCATIVE_DB_USER=postgres
VOCATIVE_DB_PASSWORD=password
VOCATIVE_DB_NAME=vocativedb
VOCATIVE_DB_RETRIES=10Docker compose
- update
docker-compose.ymlenvironment variables values - run
docker-compose up -d
Standalone
VOCATIVE_DB_NAME=vocative_db_test ./vocative-apiDatabase setup
Requirements
- PostgreSQL
- Basic PostgreSQL extenstions
Setup
- download ziped CSV files from http://www.validace.cz/cim-poslouzime.html
- extract .zip files
- update paths in
import.sqlscript - run
import.sqlscript
Data URLs
- Firstnames:
- Surnames:
Usage
Rest API
API Call Examples
- search for firstnames based on part of name and gender
curl 'localhost:8090/vocative/surnames/search?gender=male&name=Skupa' | jq[
{
"name": "Skůpa",
"vocative": "Skůpo",
"count": 63,
"gender": "male"
},
{
"name": "Skupa",
"vocative": "Skupo",
"count": 42,
"gender": "male"
}
]- get all firstnames
curl 'localhost:8090/vocative/firstnames' | jq[
{
"name": "Marie",
"vocative": "Marie",
"count": 316559,
"gender": "female"
},
{
"name": "Jiří",
"vocative": "Jiří",
"count": 315369,
"gender": "male"
},
{
"name": "Jan",
"vocative": "Jane",
"count": 295627,
"gender": "male"
},
...
]- get vocative for a name
curl 'localhost:8090/vocative/firstnames/Jan' | jq[
{
"name": "Jan",
"vocative": "Jane",
"count": 295627,
"gender": "male"
},
{
"name": "Jan",
"vocative": "Jan",
"count": 1,
"gender": "female"
}
]- get vocatives for name (firstname, surname and gender)
curl 'localhost:8090/vocative?firstname=Jindrich&surname=Skupa&gender=male&limit=2' | jq[
{
"name": "Jindřich Skůpa",
"vocative": "Jindřichu Skůpo",
"count": 28678,
"gender": "male"
},
{
"name": "Jindřich Skupa",
"vocative": "Jindřichu Skupo",
"count": 28657,
"gender": "male"
},
{
"name": "Jindrich Skůpa",
"vocative": "Jindrichu Skůpo",
"count": 65,
"gender": "male"
},
{
"name": "Jindrich Skupa",
"vocative": "Jindrichu Skupo",
"count": 44,
"gender": "male"
}
]
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent