django 请求值（如何在DjangoREST框架中使用Swagger）

优质文章，第一时间送达！

django 请求值（如何在DjangoREST框架中使用Swagger）(1)

在本教程的这里，我将向您展示如何在Django REST框架中使用Swagger API。Swagger API为REST API端点提供了结构良好的文档，因此新手可以说如何在不了解其内部实现的情况下测试REST API。

本质上，Swagger做的是简单但非常强大的事情：通过添加一些附加注释，它会生成REST API描述，例如HTTP方法，路径/查询/表单参数，响应，HTTP错误代码等），甚至提供了一个简单的Web UI来对您的API的REST调用。

Swagger规范是描述RESTful API的强大定义格式，它创建RESTful接口，通过有效地映射与之关联的所有资源和操作来轻松开发和使用API。它易于学习，与语言无关，并且可以人工和机器可读。

先决条件

Python 3.8.5，Django 3.0.8，REST框架（pip install djangorestframework），Swagger（pip install django-rest-swagger）

假定您已经在系统上安装并配置了Python。

下一个任务是安装Django。首选方法是使用命令pip install Django进行安装。您可以阅读有关Django安装的更多详细信息。

我们将使用MySQL数据库服务器作为存储数据的持久系统，因此您需要阅读教程，了解如何使用django设置MySQL以执行SQL语句。

另外，您需要使用命令pip install django-rest-swagger安装Swagger模块。

我建议您先阅读Django MySQL REST CRUD API示例教程，然后再继续学习。因为此示例恰好遵循该教程。在此示例中，除了REST API CRUD示例之外，我还添加了Swagger API。

在本示例中，我将不展示项目的每个部分，因为我将与现有项目一起工作，但是我将介绍重要的更改。您以后总是可以从本教程底部的链接从我的Github帐户下载完整的项目。

项目设置

我们需要做的第一件事是创建项目目录。项目名称为djangomysqlrestcrudswagger，我们将使用以下命令创建该项目。

django-admin startproject djangomysqlrestcrudswagger

下一步是在项目内部创建一个应用程序以执行CRUD操作。使用以下命令创建一个名为restcrudswagger的应用程序。

django-admin startapp restcrudswagger

现在，我们需要将此restcrudswagger应用程序添加到项目中。因此，编辑文件djangomysqlrestcrudswagger / djangomysqlrestcrudswagger / settings.py并将以下行添加到INSTALLED_APPS部分：

INSTALLED_APPS = [</code><code> ...</code><code> 'rest_framework_swagger',</code><code> 'restcrudswagger.apps.RestcrudswaggerConfig',</code><code>]

上一行是使用文件djangomysqlrestcrudswagger / restcrudswagger / apps.py构成的。您将在此文件中看到名为=’restcrudswagger’的RestcrudswaggerConfig类。

您需要将以下行添加到上述文件（settings.py）中，否则您将看到错误“ /’AutoSchema’对象的AttributeError没有属性’get_link’”。

REST_FRAMEWORK = { 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema' }

URLS

接下来，我将更改URL方案以添加用于REST文档的Swagger API。将以下代码写入文件 djangomysqlrestcrudswagger / djangomysqlrestcrudswagger / urls.py中。

from rest_framework_swagger.views import get_swagger_view</code><code></code><code>schema_view = get_swagger_view(title='User API')</code><code></code><code>urlpatterns = [</code><code> url('^$', schema_view)</code><code>]

带有源代码的整个文件如下：

from django.urls import include, path</code><code>from rest_framework import routers</code><code>from restcrudswagger import views</code><code>from django.conf.urls import url</code><code>from rest_framework_swagger.views import get_swagger_view</code><code></code><code>router = routers.DefaultRouter</code><code>router.register(r'users', views.UserViewSet)</code><code></code><code>schema_view = get_swagger_view(title='User API')</code><code></code><code>urlpatterns = [</code><code> url('^$', schema_view),</code><code> url(r'^', include(router.urls))</code><code>]

Swagger UI Template

接下来，您需要创建Swagger模板文件，该文件将在您访问URL时呈现。

以下内容被写入djangomysqlrestcrudswagger / restcrudswagger / templates / rest_framework_swagger / index.html。

<!DOCTYPE html></code><code><html></code><code> <head></code><code> <title>Swagger</title></code><code> <meta charset="utf-8"/></code><code> <meta name="viewport" content="width=device-width, initial-scale=1"></code><code> <link rel="stylesheet" type="text/css" href="//unpkg.com/swagger-ui-dist@3/swagger-ui.css" /></code><code> </head></code><code> <body></code><code> <div id="swagger-ui"></div></code><code> <script src="//unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js"></script></code><code> <script></code><code> const ui = SwaggerUIBundle({</code><code> url: "{% url schema_url %}",</code><code> dom_id: '#swagger-ui',</code><code> presets: [</code><code> SwaggerUIBundle.presets.apis,</code><code> SwaggerUIBundle.SwaggerUIStandalonePreset</code><code> ],</code><code> layout: "BaseLayout"</code><code> })</code><code></script></code><code> </body></code><code></html>

已知问题

如果在访问URL http：// localhost：8000时看到以下错误，则可以编辑路径中提到的以下文件，如下图所示：

django 请求值（如何在DjangoREST框架中使用Swagger）(2)