【Django项目开发】自动生成接口文档(二)
创始人
2024-04-27 17:40:05
0

文章目录

  • 一、安装第三方库drf-yasg2
  • 二、注册到子应用INSTALLED_APPS
  • 三、配置路由
    • 1、注意
  • 四、接口文档中展示详细的文档说明
    • 视图类中接口的标准注释
  • 五、视图类中自己定义的方法实现接口文档注释
    • 1、注意

一、安装第三方库drf-yasg2

pip install drf-yasg2

二、注册到子应用INSTALLED_APPS

INSTALLED_APPS = ['django.contrib.admin','django.contrib.auth','django.contrib.contenttypes','django.contrib.sessions','django.contrib.messages','django.contrib.staticfiles','rest_framework','drf_yasg2',        #自动生成接口文档'corsheaders',      #cors浏览器跨域问题'erp_system',       #系统管理模块,大模块下面有:用户管理、角色管理、功能菜单管理、权限管理、机构管理、日志管理
]

三、配置路由

1、注意

接口文档并不属于某一个接口的文档,是所有接口的文档,所以需要配置到项目的u全局urls中

from django.contrib import admin
from django.urls import path,re_path,include# drf_yasg 从这里开始
from rest_framework import permissions
from drf_yasg2.views import get_schema_view
from drf_yasg2 import openapi
from erp_system.views1 import Helloschema_view = get_schema_view(openapi.Info(title="API接口文档",default_version='V1',description="erp接口文档",),public=True,permission_classes=(permissions.AllowAny,),  # 权限类
)urlpatterns = [path('admin/', admin.site.urls),re_path(r'^api/',include('erp_system.urls')),     #路由以api开头re_path(r'^api/hello/',Hello.as_view()),     #路由以api开头#path('docs/',include_docs_urls(title='接口测试平台API文档',description='这个是接口平台的文档')),re_path(r'^swagger(?P\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),  # <-- 导出  这里path('swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),  # <-- 这里path('redoc/', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),  # <-- 这里]

四、接口文档中展示详细的文档说明

视图类中接口的标准注释

class MenuView(ModelViewSet):"""create:新增菜单参数:为Menu对象,其中delete_flag,create_time,update_time不用传参,return:添加之后的对象retrieve:查询单个菜单对象list:查询所有的菜单如果参数中有pid,则查询某一个父菜单下的所有子菜单列表,pid=0表示查询顶级菜单列表update:修改菜单destroy:删除某个菜单partial_update:局部修改菜单,修改任意的某个或者某几个属性"""queryset = MenuModel.objects.filter(delete_flag=0).all()serializer_class = MenuSerializer

五、视图类中自己定义的方法实现接口文档注释

以批量删除接口为例

1、注意

swagger_auto_schema装饰器要定义在action装饰器的上面

from rest_framework.decorators import action
from drf_yasg2 import openapi
from drf_yasg2.utils import swagger_auto_schemadel_ids = openapi.Schema(type=openapi.TYPE_OBJECT, required=['ids'], properties={"ids": openapi.Schema(type=openapi.TYPE_ARRAY, items=openapi.Schema(type=openapi.TYPE_INTEGER),description="选择那些需要删除的ID(主键)")})
    @swagger_auto_schema(method='delete', request_body=del_ids,operation_description="批量删除菜单")  # 接口注释@action(methods=['delete'], detail=False)def multiple_delete(self, request, *args, **kwargs):delete_ids = request.data.get('ids')    #json格式传递过来的if not delete_ids:return Response(data={'detail': '参数错误,ids为必填参数'}, status=status.HTTP_204_NO_CONTENT)elif not isinstance(delete_ids, list):return Response(data={'detail': '参数错误,ids必须为列表'}, status=status.HTTP_204_NO_CONTENT)# 先删除传递过来的菜单MenuModel.objects.filter(id__in=delete_ids).update(delete_flag='1')# 后删除所有的子菜单for m_id in delete_ids:MenuModel.objects.filter(parent_id=m_id).update(delete_flag='1')return Response(status=status.HTTP_204_NO_CONTENT)

访问http://127.0.0.1:8000/swagger/,访问接口文档页面展示

在这里插入图片描述

相关内容

热门资讯

安卓双系统添加应用,轻松实现多... 你有没有想过,你的安卓手机里可以同时运行两个系统呢?听起来是不是很酷?想象一边是熟悉的安卓系统,一边...
pipo安卓进系统慢,探究pi... 最近是不是发现你的Pipo安卓系统更新或者运行起来特别慢?别急,今天就来给你好好分析分析这个问题,让...
怎样使用安卓手机系统,安卓手机... 你有没有发现,安卓手机已经成为我们生活中不可或缺的一部分呢?从早晨闹钟响起,到晚上睡前刷剧,安卓手机...
双系统安卓安装caj,轻松实现... 你有没有想过,你的安卓手机里装上双系统,是不是就能同时享受安卓和Windows系统的乐趣呢?没错,这...
安卓使用ios系统教程,安卓用... 你是不是也和我一样,对安卓手机上的iOS系统充满了好奇?想要体验一下苹果的优雅和流畅?别急,今天我就...
安卓系统gps快速定位,畅享便... 你有没有遇到过这样的情况:手机里装了各种地图导航软件,但每次出门前都要等上好几分钟才能定位成功,急得...
安卓手机系统更新原理,原理与流... 你有没有发现,你的安卓手机最近是不是总在提醒你更新系统呢?别急,别急,让我来给你揭秘一下安卓手机系统...
安卓系统通知管理,全面解析与优... 你有没有发现,手机里的通知就像是一群调皮的小精灵,时不时地跳出来和你互动?没错,说的就是安卓系统的通...
安卓系统手机哪买,揭秘哪里购买... 你有没有想过,拥有一部安卓系统手机是多么酷的事情呢?想象你可以自由安装各种应用,不受限制地探索各种功...
安卓系统 ipv4,基于安卓系... 你知道吗?在智能手机的世界里,有一个系统可是无人不知、无人不晓,那就是安卓系统。而在这个庞大的安卓家...
目前安卓是什么系统,探索安卓系... 亲爱的读者,你是否曾好奇过,如今安卓系统究竟是什么模样?在这个科技飞速发展的时代,操作系统如同人体的...
安卓6.0系统比5.0,从5.... 你有没有发现,自从手机更新了安卓6.0系统,感觉整个人都清爽了不少呢?没错,今天咱们就来聊聊这个话题...
安卓2.36系统升级,功能革新... 你知道吗?最近安卓系统又来了一次大变身,那就是安卓2.36系统升级!这可不是一个小打小闹的更新,而是...
安卓系统源码怎么打开,并可能需... 你有没有想过,安卓系统的源码就像是一扇神秘的门,隐藏着无数的技术秘密?想要打开这扇门,你得掌握一些小...
安卓8.0系统体验视频,智能革... 你有没有听说安卓8.0系统最近可是火得一塌糊涂啊!作为一个紧跟科技潮流的数码达人,我当然要来给你好好...
宣传系统漫画app安卓,探索安... 亲爱的读者们,你是否曾在某个午后,百无聊赖地打开手机,想要寻找一些轻松愉悦的读物?今天,我要给你介绍...
鸿蒙替换安卓系统吗,开启智能生... 你知道吗?最近科技圈里可是炸开了锅,因为华为的新操作系统鸿蒙系统,据说要大举进军手机市场,替换掉安卓...
手机安卓系统深度清理,解锁手机... 手机里的东西是不是越来越多,感觉就像一个装满了杂物的储物柜?别急,今天就来教你一招——手机安卓系统深...
安卓上的windows系统,融... 你有没有想过,在安卓手机上也能体验到Windows系统的魅力呢?没错,这就是今天我要跟你分享的神奇故...
安卓系统焦点变化事件,Andr... 你知道吗?在安卓系统的世界里,最近发生了一件超级有趣的事情——焦点变化事件。这可不是什么小打小闹,它...