api响应泛型参数 swagger_Django REST API中使用Swagger

在这篇教程中将向展示如何在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进行安装。
我们将使用MySQL数据库服务器作为存储数据的持久系统,因此了解如何使用django设置MySQL以执行SQL语句。另外,需要使用命令pip install django-rest-swagger安装Swagger模块。
在本示例中,我将不展示项目的每个部分,因为我将与现有项目一起工作,但是我将介绍重要的更改。
项目设置
我们需要创建项目目录的第一件事。项目名称为djangomysqlrestcrudswagger,我们将使用以下命令创建该项目。
django-admin startproject djangomysqlrestcrudswagger
下一步是在项目内部创建一个应用程序以执行CRUD操作。使用以下命令创建一个名为restcrudswagger的应用程序。
django-admin startapp restcrudswagger
现在,我们需要将此restcrudswagger应用程序添加到项目中。因此,编辑文件djangomysqlrestcrudswagger / djangomysqlrestcrudswagger / settings.py并将以下行添加到INSTALLED_APPS部分:
INSTALLED_APPS = [    ...    'rest_framework_swagger',    'restcrudswagger.apps.RestcrudswaggerConfig',]
上一行是使用文件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_viewschema_view = get_swagger_view(title='User API')urlpatterns = [    url('^$', schema_view)]
带有源代码的整个文件如下:
from django.urls import include, pathfrom rest_framework import routersfrom restcrudswagger import viewsfrom django.conf.urls import urlfrom rest_framework_swagger.views import get_swagger_viewrouter = routers.DefaultRouter()router.register(r'users', views.UserViewSet)schema_view = get_swagger_view(title='User API')urlpatterns = [    url('^$', schema_view),    url(r'^', include(router.urls))]
Swagger UI Template接下来,需要创建Swagger模板文件,该文件将在访问URL时呈现。
以下内容被写入djangomysqlrestcrudswagger / restcrudswagger / templates / rest_framework_swagger / index.html。
<html>  <head>    <title>Swaggertitle>    <meta charset="utf-8"/>    <meta name="viewport" content="width=device-width, initial-scale=1">    <link rel="stylesheet" type="text/css" href="//unpkg.com/swagger-ui-dist@3/swagger-ui.css" />  head>  <body>    <div id="swagger-ui">div>    <script src="//unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js">script>    <script>    const ui = SwaggerUIBundle({        url: "{% url schema_url %}",        dom_id: '#swagger-ui',        presets: [          SwaggerUIBundle.presets.apis,          SwaggerUIBundle.SwaggerUIStandalonePreset        ],        layout: "BaseLayout"      })script>  body>html>
发现的问题
如果在访问URL http:// localhost:8000时看到以下错误,则可以编辑路径中提到的以下文件,解决方法: 在第二行,改  {% load staticfiles %}{% load static %} 部署应用
现在,我准备测试构建的API。让我们使用manage.py runserver从命令行启动服务器。该应用程序将在默认端口8000上运行。测试应用
现在,那么在访问URL http://localhost:8000时,将在浏览器上看到以下屏幕: dbc3614870a0af8980bfb420769c64ae.png
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值