Consuming the API
传统上使用 API 是一个挑战。 对于给定的 HTTP 响应或请求的正文和标头中包含的所有信息，根本没有很好的可视化效果。
取而代之的是，大多数开发人员使用命令行 HTTP 客户端（例如 cURL）（如上一章所述）或 HTTPie。
2012 年，第三方软件产品 Postman 投放市场，现在全球有数百万希望通过可视化，功能丰富的方式与 API 交互的开发人员使用。
但是 Django REST 框架最令人惊奇的事情之一是，它附带了功能强大的可浏览 API，我们可以立即使用它。 如果您发现需要使用 API 进行更多自定义，则可以使用 Postman 之类的工具。 但是通常内置的可浏览 API 绰绰有余。
Browsable API
现在让我们使用可浏览的 API 与我们的数据进行交互。 确保本地服务器正在运行。
(backend) $ python manage.py runserver
然后导航到http://127.0.0.1:8000/api/以查看我们的工作 API 列表视图端点。
该页面显示了我们先前在数据库模型中创建的三个待办事项。 API 终结点称为集合，因为它显示多个项目。
我们的可浏览 API 可以做很多事情。 首先，让我们看一下原始的 JSON 视图，即实际通过互联网传输的视图。 单击右上角的“ GET”按钮，然后选择 JSON。
如果您返回http://127.0.0.1:8000/api/的列表视图页面，我们可以看到其他信息。 回想一下，HTTP 动词 GET 用于读取数据，而 POST 用于更新或创建数据。
在“列表待办事项”下显示 GET / api /，它告诉我们我们在此端点上执行了 GET。 下方显示的是 HTTP 200 OK，这是我们的状态代码，一切正常。 最重要的是，它下面显示允许：GET，HEAD，OPTIONS。 请注意，由于这是一个只读端点，因此不包括 POST，我们只能执行 GET。
我们还为每个模型制作了一个 DetailTodo 视图。 这称为实例，在http://127.0.0.1:8000/api/1/上可见。
您也可以导航至以下端点：
CORS
我们需要做的最后一步是跨源资源共享（CORS）。 每当客户端与不同域（mysite.com 与 yoursite.com）或端口（localhost：3000 与 localhost：8000）上托管的 API 进行交互时，都会存在潜在的安全问题。
具体来说，CORS 要求服务器包含特定的 HTTP 标头，以允许客户端确定是否以及何时应允许跨域请求。
我们的 Django API 后端将与专用前端通信，该前端位于用于本地开发的不同端口上，并在部署后位于另一个域上。
处理此问题的最简单方法（以及 Django REST 框架建议的一种方法）是使用中间件，该中间件将根据我们的设置自动包括适当的 HTTP 标头。
我们将使用的软件包是 django-cors-header，可以轻松将其添加到我们现有的项目中。
首先使用 Control + c 退出我们的服务器，然后使用 Pipenv 安装 django-cors-headers。
(backend) $ pipenv install django-cors-headers==3.1.1
接下来，在三个位置更新我们的 settings.py 文件：
- 将
corsheaders添加到 INSTALLED_APPS - 在 MIDDLEWARE 中把
CorsMiddleware添加到CommonMiddleWare的上方 - 创建一个
CORS_ORIGIN_WHITELIST
# todo_project/settings.py INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', # 3rd party 'rest_framework', 'corsheaders', # new # Local 'todos.apps.TodosConfig', ] MIDDLEWARE = [ 'django.middleware.security.SecurityMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'corsheaders.middleware.CorsMiddleware', # new 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', ] # new CORS_ORIGIN_WHITELIST = ( 'http://localhost:3000', 'http://localhost:8000', )
将 corsheaders.middleware.CorsMiddleware 出现在正确的位置非常重要。 由于中间件是从上到下加载的，因此它位于 MIDDLEWARE 设置中的 django.middleware.common.CommonMiddleware 之上。 另外请注意，我们已将两个域列入白名单：localhost：3000 和 localhost：8000。 前者是 React 的默认端口，下一章将在前端使用它。 后者是默认的 Django 端口。
测试
您应该始终为 Django 项目编写测试。 前期花费的少量时间将为您节省大量的时间和以后的调试错误。 让我们添加两个基本测试，以确认标题和正文内容的行为符合预期。
打开 todos / tests.py 文件，并添加以下内容：
# todos/tests.py from django.test import TestCase from .models import Todo class TodoModelTest(TestCase): @classmethod def setUpTestData(cls): Todo.objects.create(title='first todo', body='a body here') def test_title_content(self): todo = Todo.objects.get(id=1) expected_object_name = f'{todo.title}' self.assertEquals(expected_object_name, 'first todo') def test_body_content(self): todo = Todo.objects.get(id=1) expected_object_name = f'{todo.body}' self.assertEquals(expected_object_name, 'a body here')
它使用 Django 的内置 TestCase 类。 首先，我们在 setUpTestData 中设置数据，然后编写两个新测试。 然后使用 python manage.py test 命令运行测试。
(backend) $ python manage.py test ... Ran 2 tests in 0.002s OK
就是这样！ 我们的后端现已完成。 确保服务器正在运行，因为我们将在下一章中使用它。
(backend) $ python manage.py runserver
总结
只需最少的代码，Django REST Framework 便允许我们从头开始创建 Django API。 我们从传统 Django 需要的唯一组件是 models.py 文件和 urls.py 路由。 views.py 和 serializers.py 文件完全是 Django REST Framework 特有的。
与上一示例不同，我们没有为该项目构建任何网页，因为我们的目标只是创建一个 API。 但是，在将来的任何时候，我们都可以轻松实现！ 只需添加一个新视图，URL 和一个模板即可公开我们现有的数据库模型。
在此示例中，重要的一点是我们添加了 CORS 标头，并且仅将域 localhost：3000 和 localhost：8000 明确设置为可以访问我们的 API。 第一次开始构建 API 时，很容易混淆正确设置 CORS 标头。
我们可以做更多的配置，以后再做，但最终，创建 Django API 的过程是建立模型，编写一些 URL 路由，然后添加 Django REST Framework 的序列化程序和视图所提供的一些魔术。
