Django 集成 Swagger

最新推荐文章于 2025-07-22 14:55:36 发布

alibao

最新推荐文章于 2025-07-22 14:55:36 发布

阅读量636

点赞数

CC 4.0 BY-SA版权

分类专栏： Python-Web 文章标签： django python 后端

本文链接：https://blog.csdn.net/u013591740/article/details/125795269

一、安装drf-yasg2 (Swagger)

pip install drf-yasg2

二、在项目中配置Swagger

# setting.py文件
SWAGGER_SETTINGS = {
	'DEFAULT_INFO': 'server.urls.openapi_info' # 这个是urls.py文件中的openapi对象
}

# urls.py
# drf_yasg2 ===============================start
from rest_framework import permissions
from drf_yasg2.views import get_schema_view
from drf_yasg2 import openapi
openapi_info = openapi.Info(
        title="测试API",
        default_version='v1',
        description="使用swaggerUI测试",
        # terms_of_service="https://www.tweet.org",
        contact=openapi.Contact(email="xxxxx.com"),
        # license=openapi.License(name="Awesome IP"),
    )
schema_view = get_schema_view(
    openapi_info,
    public=True,
    permission_classes=(permissions.AllowAny,),
)
# drf_yasg2 ===============================start

urlpatterns = [
    re_path(r'^doc(?P<format>\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),