智慧水务项目（四）django(drf)+angular 18 添加drf_yasg api接口文档

浪淘沙jkp

已于 2024-08-02 23:26:38 修改

阅读量600

点赞数 2

CC 4.0 BY-SA版权

分类专栏：智慧水务项目文章标签： django python 后端

于 2024-08-02 23:25:16 首次发布

本文链接：https://blog.csdn.net/jiangkp/article/details/140881629

一、说明

文档api接口是必须的

本来准备用coreapi，据说drf_yasg更流弊

二、步骤

1、requirements.txt添加drf-yasg

2、settings.py中添加部分代码

drf_yasg需要与django.contrib.staticfiles配套使用，一般情况下，项目创建都会在INSTALLED_APPS列表中注册这个工具，如果没有，需要手动添加

在settings.py最后面添加下面代码

# ====================================#
# ****************swagger************#
# ====================================#
SWAGGER_SETTINGS = {
    # 基础样式
    "SECURITY_DEFINITIONS": {"basic": {"type": "basic"}},
    # 如果需要登录才能够查看接口文档, 登录的链接使用restframework自带的.
    "LOGIN_URL": "apiLogin/",
    # 'LOGIN_URL': 'rest_framework:login',
    "LOGOUT_URL": "rest_framework:logout",
    # 'DOC_EXPANSION': None,
    # 'SHOW_REQUEST_HEADERS':True,
    # 'USE_SESSION_AUTH': True,
    # 'DOC_EXP