Views

Each view is a function which receives a dictonary, called params, and must return a dictionary.

Use the banjo.urls.route_get and banjo.urls.route_post decorators to route URLs to your view functions.

Be sure to import the route decorators and model:

# app/views.py
from banjo.urls import route_get, route_post
from .models import Person

@route_get(endpoint,args)

Creates a GET API at the specified endpoint

Endpoint: must include a string to denote the endpoint
Args (optional): can include a payload in the format of a dictionary - the key must be a string and the value must be the expected data type

example:

# app/views.py
from banjo.urls import route_get, route_post
from .models import Person

@route_get('all')

@route_post(endpoint,args)

Creates a POST API at the specified endpoint

Endpoint: must include a string to denote the endpoint
Args (optional): can include a payload in the format of a dictionary - the key must be a string and the value must be the expected data type

example:

# app/views.py
from banjo.urls import route_get, route_post
from models import Person

@route_post('add_person', args={'name': str, 'email_address': str})

All view functions must:

include params as a funciton parameter, regardless if the endpoint requires a payload
return a dictionary to ensure propert JSON formatting

To create a GET view:

@route_get('all')
def all_persons(params):
    if Person.objects.exists():
        all_persons = []

        for person in Person.objects.all():
            all_persons.append(person.to_dict())

        return {'all persons': all_persons}

    else:
        return {'error': 'no persons exisit'}

To create a POST view:

@route_post('add_person', args={'name': str, 'email_address': str})
def add_person(params):
    new_person = Person.from_dict(params)
    new_person.save()

    return new_person.to_dict()