在django中使用RESTFUL API中的数据的正确方法

Question

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

http://api.example.com/books?author=edwards&year=2009

Thsis将返回Edwards于2009年撰写的书籍清单.返回以下格式:

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

目前我正在使用我的视图文件中的API,如下所示:

class BooksPage(generic.TemplateView):
    def get(self,request):
        r = requests.get('http://api.example.com/books?author=edwards&year=2009')
        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编写了上面的例子,所以任何bug都纯粹是在这里编写它的结果.

Answer 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)

也可以看看:

• 在django中分离业务逻辑和数据访问