History

Nikola Forró 231ea6a4f3 Add API key generator script		7 years ago
..
.gitignore	Update app/.gitignore	7 years ago
Dockerfile	Containerize the app	7 years ago
README.md	Remove unnecessary video_id	7 years ago
app.py	Containerize the app	7 years ago
db.py	Remove unnecessary video_id	7 years ago
generate_api_key.py	Add API key generator script	7 years ago
requirements.txt	Containerize the app	7 years ago

README.md

HTTP API documentation

Get specific quote

GET /quotes/:id

curl --request GET 'https://tld.example/api/quotes/28'

Example response:

{
    "id": 28,
    "date": "2018-01-01",
    "game": "IRL",
    "text": "Cheese?",
    "created_at": "2018-01-01T00:00:00",
    "updated_at": "2018-01-01T00:00:00"
}

Get list of quotes

GET /quotes

curl --request GET --data 'https://tld.example/api/quotes?filter=cheese&sort_by=date&sort_order=asc'

Note: X-Total-Count header is set to a total number of quotes after filtering (useful for pagination)

Example response:

[
    {
        "id": 28,
        "date": "2018-01-01",
        "game": "IRL",
        "text": "Cheese?",
        "created_at": "2018-01-01T00:00:00",
        "updated_at": "2018-01-01T00:00:00"
    },
    {
        "id": 42,
        "date": "2018-02-02",
        "game": "IRL",
        "text": "Cheese!",
        "created_at": "2018-02-02T00:00:00",
        "updated_at": "2018-02-02T00:00:00"
    }
]

Parameters:

filter (optional) - Filter string
sort_by (optional) - Sort field, id, date, game or text
sort_order (optional) - Sort order, asc or desc
page_number (optional) - Page number to retrieve
page_size (optional) - Number of quotes per page

Create quote

POST /quotes

curl --request POST --header 'X-Quotes-API-Key: SECRET_KEY' --data 'id=28&date=2018-01-01&game=IRL&text=Cheese?' 'https://tld.example/api/quotes'

Note: the quote is replaced if it exists already

Parameters:

id (required) - Quote ID
date (required) - Date in ISO 8601 format
game (required) - Related game
text (required) - Text of the quote

Replace specific quote

PUT /quotes/:id

curl --request PUT --header 'X-Quotes-API-Key: SECRET_KEY' --data 'date=2018-01-01&game=IRL&text=Cheese?' 'https://tld.example/api/quotes/28'

Note: the quote is created if it doesn't exist yet

Parameters:

date (required) - Date in ISO 8601 format
game (required) - Related game
text (required) - Text of the quote

Delete specific quote

DELETE /quotes/:id

curl --request DELETE --header 'X-Quotes-API-Key: SECRET_KEY' 'https://tld.example/api/quotes/28'