Proper way to consume data from RESTFUL API in django

PythonDjangoRestRestful Architecture

Python Problem Overview

I'm trying to learn django so while I have a current solution I'm not sure if it follows best practices in django. I would like to display information from a web api on my website. Let's say the api url is as follows:

Thsis would return a list of books by Edwards written in the year 2009. Returned in the following format:

                   'title':'Book 1',
                   'Author':'Edwards Man',
                   'title':'Book 2',
                   'Author':'Edwards Man',

Currently I am consuming the API in my views file as follows:

class BooksPage(generic.TemplateView):
    def get(self,request):
        r = requests.get('')
        books = r.json()
        books_list = {'books':books['results']}
        return render(request,'books.html',books_list)

Normally, we grab data from the database in the file, but I am unsure if I should be grabbing this API data in or If it should be in, can someone provide an example of how to do this? I wrote the above example sepecifically for stackoverflow, so any bugs are purely a result of writing it here.

Python Solutions

Solution 1 - Python

I like the approach of putting that kind of logic in a separate service layer (; the data you are rendering is quite not a "model" in the Django ORM sense, and it's more than simple "view" logic. A clean encapsulation ensures you can do things like control the interface to the backing service (i.e., make it look like a Python API vs. URL with parameters), add enhancements such as caching, as @sobolevn mentioned, test the API in isolation, etc.

So I'd suggest a simple, that looks something like this:

def get_books(year, author):
    url = '' 
    params = {'year': year, 'author': author}
    r = requests.get(url, params=params)
    books = r.json()
    books_list = {'books':books['results']}
    return books_list

Note how the parameters get passed (using a capability of the requests package).

Then in

import services
class BooksPage(generic.TemplateView):
    def get(self,request):
        books_list = services.get_books('2009', 'edwards')
        return render(request,'books.html',books_list)

See also:

Solution 2 - Python

Use the serializer instead of .json, as it gives flexibility to return in a number of formats.As while using rest-api , the provided serializer use is preferred.

Also keep the data handling and get data requests in forms are used for templating not as the business logic.

Solution 3 - Python

Well, there are several things to keep in mind. First of all, in this case your data is not changing so often. So it is a good practice to cache this kind of responces. There are a lot of caching tools around, but redis is a popular option. Alternatevly, you can choose additional NoSQL database just for caching.

Secondly, what is the purpose of displaying this data? Are you expecting your users to interact with books or authors, etc? If it is just an information, there is no need in forms and models. If not, you must provide proper views, forms and models for both books and authors, etc.

And considering the place where you should call an API request, I would say it dependes heavily on the second question. Choices are:

  • for just displaying data.
  • or still for ineractivity.

Solution 4 - Python

                {% if libros %}
                {% for libro in libros %}
                    <td>{{ }}</td>
                    <td>{{ libro.titulo }}</td>
                    <td>{{ libro.autor }}</td>
                    <td>{{ libro.eiditorial }}</td>
                    <td>{{ libro.descripcion }}</td>
                    <td>{{ libro.cantidad }}</td>
                    <td>{{ libro.Bodega.nombre }}</td>
                        {% if libro.imagen %}
                    <td><img src= "{{ libro.imagen.url }} "align="center" width="50px" ></td>
                    {% else %}
                    <h6>no hay imagen de libros</h6>
                    {% endif %}
                    <td><a class ="btn btn-primary "href="/">Editar</a></td>
                    <td><a class ="btn btn-danger red"href="/">Eliminar</a></td>
                {% endfor %}
                {% else %}
                <h1>no hay registros de libros</h1>
                {% endif%}

as I can call it in an html when I already have a list of my local application greetings


All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
Questionuser2694306View Question on Stackoverflow
Solution 1 - PythonbimsapiView Answer on Stackoverflow
Solution 2 - PythonPrateek099View Answer on Stackoverflow
Solution 3 - PythonsobolevnView Answer on Stackoverflow
Solution 4 - PythonGuillermo Andres Montecinos PaView Answer on Stackoverflow