Django中的swagger文档

最新推荐文章于 2024-07-02 18:02:16 发布

榤捷ღ

最新推荐文章于 2024-07-02 18:02:16 发布

阅读量389

点赞数

文章标签： django python 后端

本文链接：https://blog.csdn.net/m0_65862716/article/details/125303725

版权

本文介绍如何在Django项目中快速配置并使用Swagger UI，通过drf-yasg2库实现API文档的自动化生成。包括安装、settings配置、urls.py更新、视图集成及测试过程。

摘要由CSDN通过智能技术生成

Swagger UI 是公认的API 文档说明最好的，

只需要花费两分钟就可以配置好，在这里我们使用drf-yasg2

首先需要下载：pip install drf-yasg2

然后需要在setting里配置

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'one',
    'corsheaders',
    'rest_framework',
    'news',
    'django_crontab',
    'drf_yasg2',  #<----这里
]

还需要更新urls.py文件

# drf_yasg2 从这里开始
from rest_framework import permissions
from drf_yasg2.views import get_schema_view
from drf_yasg2 import openapi
schema_view = get_schema_view(
    openapi.Info(
        title="Tweet API",
        default_version='v1',
        description="Welcome to the wor