django配置swagger

本文介绍了如何在SpringBoot和Django项目中使用drf-yasg进行接口文档的生成,包括安装、配置和实际应用。同时提到了rest_framework的使用,以及如何创建模型、序列化器和过滤器。文章还推荐了drf-spectacular作为替代方案。

前言:

在SpringBoot常用的接口测试,接口文档生成的工具 swagger


一、安装

pip install    drf-yasg

pip  install  djangorestframork

二、子django项目中配置

settings.py

INSTALLED_APPS = [
        ....

        'rest_framework',

        'drf_yasg',  # swagger 接口 'app1',
        .....

]

urls.py

from rest_framework import permissions
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
schema_view = get_schema_view(
    openapi.Info(
        title="Snippets API",
        default_version='v1',
        description="Test description",
        terms_of_service="https://www.google.com/policies/terms/",
        contact=openapi.Contact(email="contact@snippets.local"),
        license=openapi.License(name="BSD License"),
    ),
    public=True,
    permission_classes=[permissions.AllowAny],
)

from django.contrib import admin
from django.urls import path, re_path
from app1 import views as app_views
urlpatterns = [
    path('admin/', admin.site.urls),
    path('demo/',app_views.demo,name="dmeo"),
    # 对测试人员更友好
    re_path(r'^$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),#《----------
    re_path(r'^swagger(?P<format>\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),#《----------
    re_path(r'^swagger/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),#《----------
    # 对开发人员更友好
    re_path(r'^redoc/$', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),#《----------

]

启动项目:

e6a1d50543e846d28bdb20ad9abed319.png

三、通过 rest_framework实现接口

rest_framework的简单使用

安装:

pip install djangorestframework
pip install django-filters

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值