README.md

RWTP

An API for getting translation of random english words to a language of choice together with the correct pronunciation.

REST API - list of endpoints

The base url is:

base_url = https://words-translation.herokuapp.com

List of endpoints (unauthenticated user):

endpoint	feature	method
/translations/	get 50 random English words with translations for all supported languages	GET
/available_conversions/	get all available conversions, i.e. translation from english en to various languages x in the en-x format. Currently, x can only be any of the following pl, de, fr, es, ru, it, sv and zh. More will come later.	GET
/translation/?conversion=en-x/	get 50 random English words with translations to a language x, which has to be in a ISO 639-1 format	GET
/languages/	get 50 random English words and translations for all supported languages, categorized by language conversion	GET

Authenticated user can additionally send POST and DELETE requests, e.g.:

endpoint	feature	method
/languages/en-x/delete/	delete a given conversion en-x Currently, x can only be any of the following pl, de, fr, es, ru, it, sv and zh. More will come later. x has to be in a ISO 639-1 format	DELETE
/languages/	add a new conversion en-x where x has to be in a ISO 639-1 format. An example dict passed as data {"conversion": "en-fr"}	POST
/translations/<int:id>/delete/	remove translation by id which is a primary key	DELETE
/translations/	add a new translation. An example dict passed as data is {'conversion': 'en-pl', "i": 18, "frontCard": "some_word", "backCard": "some_translation", "pronunciation_frontCard": "here_will_be_the_link", "pronunciation_backCard": "here_will_be_the_link", "source_language": "en-US", "target_language": "pl"}	POST

Quicktest

To quickly test the server response, try this:

curl -H 'Accept: application/json; indent=4' https://words-translation.herokuapp.com/translations/

You should receive a response like that

[
    {
        "id": 1,
        "frontCard": "adviser",
        "backCard": "doradca",
        "pronunciation_frontCard": "http://res.cloudinary.com/hqzs7d3nl/raw/upload/v1625904765/en-US/adviser.mp3",
        "pronunciation_backCard": "http://res.cloudinary.com/hqzs7d3nl/raw/upload/v1625904766/pl/doradca.mp3",
        "frontCard_language": "en-US",
        "backCard_language": "pl"
    },
    {
        "id": 2,
        "frontCard": "personality",
        "backCard": "osobowość",
        "pronunciation_frontCard": "http://res.cloudinary.com/hqzs7d3nl/raw/upload/v1625904767/en-US/personality.mp3",
        "pronunciation_backCard": "http://res.cloudinary.com/hqzs7d3nl/raw/upload/v1625904768/pl/osobowo%C5%9B%C4%87.mp3",
        "frontCard_language": "en-US",
        "backCard_language": "pl"
    },
    ...
    {
        ...
    }
    ...
]