关于swagger

Swagger能成为最受欢迎的REST APIs文档生成工具之一,有以下几个原因:

  • Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。
  • Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
  • Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
  • Swagger 有一个强大的社区,里面有许多强悍的贡献者。

下面就实战django rest swagger为drf生成api接口文档

环境

  • Python3.6
  • Django1.11
  • django-rest-swagger
  • djangorestframework

安装

  1. pip install django==1.11.6
  2. pip instal djangorestframework
  3. pip install django-rest-swagger

创建项目和app

  1. startproject apitest
  2. startapp api

配置 rest_api/settings.py

  1. INSTALLED_APPS = [
  2. 'django.contrib.admin',
  3. 'django.contrib.auth',
  4. 'django.contrib.contenttypes',
  5. 'django.contrib.sessions',
  6. 'django.contrib.messages',
  7. 'django.contrib.staticfiles',
  8. # 加入以下
  9. 'api',
  10. 'rest_framework',
  11. 'rest_framework_swagger',
  12. ]
  13. # swagger 配置项
  14. SWAGGER_SETTINGS = {
  15. # 基础样式
  16. 'SECURITY_DEFINITIONS': {
  17. "basic":{
  18. 'type': 'basic'
  19. }
  20. },
  21. # 如果需要登录才能够查看接口文档, 登录的链接使用restframework自带的.
  22. 'LOGIN_URL': 'rest_framework:login',
  23. 'LOGOUT_URL': 'rest_framework:logout',
  24. # 'DOC_EXPANSION': None,
  25. # 'SHOW_REQUEST_HEADERS':True,
  26. # 'USE_SESSION_AUTH': True,
  27. # 'DOC_EXPANSION': 'list',
  28. # 接口文档中方法列表以首字母升序排列
  29. 'APIS_SORTER': 'alpha',
  30. # 如果支持json提交, 则接口文档中包含json输入框
  31. 'JSON_EDITOR': True,
  32. # 方法列表字母排序
  33. 'OPERATIONS_SORTER': 'alpha',
  34. 'VALIDATOR_URL': None,
  35. }

配置api/serializer.py

  1. # 序列化
  2. from django.contrib.auth.models import User,Group
  3. from rest_framework import serializers
  4. class UserSerializer(serializers.HyperlinkedModelSerializer):
  5. class Meta:
  6. model = User
  7. fields = "__all__"
  8. class GroupSerializer(serializers.HyperlinkedModelSerializer):
  9. class Meta:
  10. model =Group
  11. fields = "__all__"

配置api/views.py

  1. # 视图
  2. from django.contrib.auth.models import User,Group
  3. from rest_framework import viewsets
  4. from api.serializers import UserSerializer,GroupSerializer
  5. # Create your views here.
  6. class UserViewSet(viewsets.ModelViewSet):
  7. '''查看,编辑用户的界面'''
  8. queryset = User.objects.all().order_by('-date_joined')
  9. serializer_class = UserSerializer
  10. class GroupViewSet(viewsets.ModelViewSet):
  11. '''查看,编辑组的界面'''
  12. queryset = Group
  13. serializer_class = GroupSerializer

配置apitest/urls.py

  1. from django.conf.urls import url,include
  2. from django.contrib import admin
  3. from rest_framework import routers
  4. from api import views
  5. # 路由
  6. router = routers.DefaultRouter()
  7. router.register(r'users',views.UserViewSet,base_name='user')
  8. router.register(r'groups',views.GroupViewSet,base_name='group')
  9. # 重要的是如下三行
  10. from rest_framework.schemas import get_schema_view
  11. from rest_framework_swagger.renderers import SwaggerUIRenderer, OpenAPIRenderer
  12. schema_view = get_schema_view(title='Users API', renderer_classes=[OpenAPIRenderer, SwaggerUIRenderer])
  13. urlpatterns = [
  14. # swagger接口文档路由
  15. url(r'^docs/', schema_view, name="docs"),
  16. url(r'^admin/', admin.site.urls),
  17. url(r'^',include(router.urls)),
  18. # drf登录
  19. url(r'^api-auth/',include('rest_framework.urls',namespace='rest_framework'))
  20. ]

最终效果

drf自带的接口UI

swagger UI

Django Rest Swagger生成api文档的更多相关文章

  1. 12 Django Rest Swagger生成api文档

    01-简介 Swagger:是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.总体目标是使客户端和文件系统源代码作为服务器以同样的速度来更新.当接口有变动时,对应的接 ...

  2. .Net Core 3.1 WebApi使用Swagger生成Api文档

    用swagger生成Api文档 1.安装Swashbuckle.AspNetCore 右键单击"解决方案资源管理器" > "管理 NuGet 包"中的项目 ...

  3. ASP.NET Core 3.0 WebApi中使用Swagger生成API文档简介

    参考地址,官网:https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle?view ...

  4. Laravel(PHP)使用Swagger生成API文档不完全指南 - 基本概念和环境搭建 - 简书

    在PHPer中,很多人听说过Swagger,部分人知道Swagger是用来做API文档的,然而只有少数人真正知道怎么正确使用Swagger,因为PHP界和Swagger相关的资料实在是太少了.所以鄙人 ...

  5. 使用swagger生成API文档

    有时候一份清晰明了的接口文档能够极大地提高前后端双方的沟通效率和开发效率.本文将介绍如何使用swagger生成接口文档. swagger介绍 Swagger本质上是一种用于描述使用JSON表示的RES ...

  6. Django使用swagger生成接口文档

    参考博客:Django接入Swagger,生成Swagger接口文档-操作解析 Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.总体目标是使客户端和文 ...

  7. 浅析如何在Nancy中使用Swagger生成API文档

    前言 上一篇博客介绍了使用Nancy框架内部的方法来创建了一个简单到不能再简单的Document.但是还有许许多多的不足. 为了能稍微完善一下这个Document,这篇引用了当前流行的Swagger, ...

  8. Web Api 2.0中使用Swagger生成Api文档的2个小Tips

    当Web Api 2.0使用OAuth2授权时,如何在Swagger中添加Authorization请求头? Swagger说明文档支持手动调用Api, 但是当Api使用OAuth2授权时,由于没有地 ...

  9. .NET Core和Swagger 生成 Api 文档

    测试/生产环境的BUG 这里更新一下在本地调试正常,在INT/PROD上抛错,错误信息为: */**/*.xml(Swagger json file) 文件找不到,在startup 里builder ...

随机推荐

  1. zabbix-3.4.10系列

    第1节 zabbix体系架构图:

  2. Balanced Numbers (数位dp+三进制)

    SPOJ - BALNUM 题意: Balanced Numbers:数位上的偶数出现奇数次,数位上的奇数出现偶数次(比如2334, 2出现1次,4出现1次,3出现两次,所以2334是 Balance ...

  3. [leetcode]32. Longest Valid Parentheses最长合法括号子串

    Given a string containing just the characters '(' and ')', find the length of the longest valid (wel ...

  4. 校验金额、大小写字母、大写字母、合法uri、email

    /* 合法uri*/ export function validURL(url) { const reg = /^(https?|ftp):\/\/([a-zA-Z0-9.-]+(:[a-zA-Z0- ...

  5. Zookeeper 集群配置及启动

    准备工作 1. 集群机器 192.168.8.2 192.168.8.6 192.168.8.11 2. 包 zookeeper-3.4.10.tar.gz 集群配置 1. 解压路径 192.168. ...

  6. IP、TCP、DNS协议

    ·······················································IP协议························· 位于网络层,作用是把数据包传送 ...

  7. 模板学习实践三 functor

    #include <iostream>#include <typeinfo> void foo(){ std::cout << "foo() called ...

  8. python爬虫笔记

    1.抓取网页并保存到txt中.解决控制台乱码问题 #_*_coding:utf-8_*_ import urllib2 response = urllib2.urlopen('http://hws.m ...

  9. SQL SERVER 小语法

    1. 取字段长度:len select * from 表名 where len(expmessage)=1 2.rtrim, ltrim rtrim(ObjectName)

  10. 11. English vocabulary 英语词汇量

    11. English vocabulary 英语词汇量 (1) The exact number of English words is not known.The large dictionari ...