example_rest_api_bestemmie.py

import requests

BASE_URL = "http://bestemmie.org/api/{endpoint}"

# GET ALL BESTEMMIE
# ENDPOINT: /bestemmie
''' 
    Method: GET

    Optional params:
        offset (default 50)
        limit (default 50)

    Response field:
        count: total distinct count of bestemmie
        next: the url to the next page
        previous: the url to the previous page
        results: array of bestemmie with the single count of how many time was inserted

    Response example:
        {
            "count": 984,
            "next": "http://bestemmie.org/api/bestemmie/?limit=50&offset=50",
            "previous": null,
            "results": [
                {
                    "bestemmia": "DIO CANE",
                    "count": 2
                },
                ...
            ]
        }

'''
response = requests.get(BASE_URL.format(endpoint="bestemmie"))
response.raise_for_status()
print(response.json()['results'])
''' 
    [ {'count': 2, 'bestemmia': u'DIO CANE'}, ...]
'''

# ADD BESTEMMIA
# ENDPOINT: /bestemmie/
''' 
    Method: POST

    *notice, the endpoint ends with "/"
'''
params = {
    "bestemmia": "Dio cane"
}
response = requests.post(BASE_URL.format(endpoint="bestemmie/"), params)
response.raise_for_status()
'''
    Return 204 no content
'''


# GET RANDOM BESTEMMIA
# ENDPOINT: /random
''' 
    Method: GET

    Response example:
        {
            "bestemmia": "DIO CANE",
            "count": 2
        }
  
'''
response = requests.get(BASE_URL.format(endpoint="random"))
response.raise_for_status()
print(response.json())
''' 
    {'count': 1, 'bestemmia': u'DIO CANE'}
'''