Sign inSign up

tooleks/shevchenko

By tooleks

•Updated 7 months ago

shevchenko.js HTTP API

Image
3

3.3K

tooleks/shevchenko repository overview

⁠shevchenko.js HTTP API

HTTP API to interact with shevchenko.js⁠ library.

⁠Installation

To pull the Docker image, use the following command:

docker pull tooleks/shevchenko

To start the Docker container, use the following command:

docker run --name shevchenko -p 3000:3000 -d tooleks/shevchenko

To verify the installation, run the following command:

wget -qO- http://localhost:3000/ 2>&1

The example output:

{"name":"shevchenko","version":"X.X.X"}

⁠Public Endpoints

http://localhost:3000/nominative
http://localhost:3000/genitive
http://localhost:3000/dative
http://localhost:3000/accusative
http://localhost:3000/ablative
http://localhost:3000/locative
http://localhost:3000/vocative
http://localhost:3000/gender

⁠Usage Example

⁠Personal names declension

This example shows how to use the API to decline Ukrainian anthroponyms.

⁠HTTP Request
POST /vocative HTTP/1.1
Host: localhost:3000
Content-Type: application/json

{
    "gender": "masculine",
    "givenName": "Тарас",
    "patronymicName": "Григорович",
    "familyName": "Шевченко"
}
⁠HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "givenName": "Тарасе",
  "patronymicName": "Григоровичу",
  "familyName": "Шевченку"
}
⁠Automatic grammatical gender detection

This example shows how to use the API to automatically detect the grammatical gender of a Ukrainian anthroponym.

⁠HTTP Request
POST /vocative HTTP/1.1
Host: localhost:3000
Content-Type: application/json

{
    "givenName": "Лариса",
    "patronymicName": "Петрівна",
    "familyName": "Косач-Квітка"
}
⁠HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "givenName": "Ларисо",
  "patronymicName": "Петрівно",
  "familyName": "Косач-Квітко"
}

Tag summary

Content type

Image

Digest

sha256:08c94b564…

Size

109.1 MB

Last updated

7 months ago

docker pull tooleks/shevchenko