在Django中使用来自RESTFUL API的数据的正确方法

一尘不染

在Django中使用来自RESTFUL API的数据的正确方法

django

我正在尝试学习django，所以当我有一个当前的解决方案时，我不确定它是否遵循django中的最佳实践。我想在我的网站上显示来自Web api的信息。假设api网址如下：

http://api.example.com/books?author=edwards&year=2009
Thsis将返回Edwards在2019年写的书籍清单。以以下格式返回：

{'results':
             [
                {
                   'title':'Book 1',
                   'Author':'Edwards Man',
                   'Year':2019
                },
                {
                   'title':'Book 2',
                   'Author':'Edwards Man',
                   'Year':2019}
           ]
}

目前，我正在如下视图中使用API：

class BooksPage(generic.TemplateView):
    def get(self,request):
        r = requests.get('http://api.example.com/books?author=edwards&year=2019')
        books = r.json()
        books_list = {'books':books['results']}
        return render(request,'books.html',books_list)

通常，我们从models.py文件中的数据库中获取数据，但是我不确定是否应该在models.py或views.py中获取此API数据。如果应该在models.py中，可以有人提供如何执行此操作的示例吗？我为stackoverflow专门编写了上面的示例，因此任何错误纯粹是在此处编写的结果。

阅读 575

2020-03-31

共1个答案

一尘不染

我喜欢将这种逻辑放在单独的服务层（services.py）中的方法；从Django ORM的角度来看，你呈现的数据不是一个“模型”，它不仅仅是简单的“视图”逻辑。干净的封装可确保你执行以下操作：控制与支持服务的接口（即，使其看起来像Python API还是带有参数的URL），添加诸如缓存的增强功能（如@sobolevn所述），单独测试API，等等

所以我建议一个简单的services.py，看起来像这样：

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

注意如何传递参数（使用requests软件包的功能）。

然后在views.py：

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

2020-03-31