self.user = serializer_field.context['request'].user KeyError: 'request

本文探讨了Django REST Framework中APIView与GenericAPIView的细节差异,特别是关于context处理的不同。当使用CurrentUserDefault()时,若不正确处理context,可能会遇到KeyError。文章提供了如何在APIView中正确传递context的示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

django DRF:

APIView和通用API的细节区别:

 

 使用CurrentUserDefault()时报错:

user = serializers.HiddenField(
default=serializers.CurrentUserDefault()

 报错如下:

File "C:\Users\sz.yu\Envs\Smartshop\lib\site-packages\rest_framework\fields.py", line 271, in set_context 

self.user = serializer_field.context['request'].user 

KeyError: 'request'

 

这是因为我使用的APIView而不是GenericAPIView(GenericAPIView会自动对context处理,而APIView不会) 

所有视图中序列化应该这样写:

def post(self, request, format=None):
context = {
"request":request,
}
serializer = UserMessageCreateSerializer(data=request.data, context=context)
if serializer.is_valid(raise_exception=True):
serializer.save()
return Response(serializer.data, status=HTTP_201_CREATED, content_type="application/json")

 额外传递 context=context参数

 

转载于:https://www.cnblogs.com/yushengzhou/p/9873140.html

MultiValueDictKeyError at /auth/users/ 'password' Request Method: POST Request URL: http://127.0.0.1:8000/auth/users/ Django Version: 4.2.21 Exception Type: MultiValueDictKeyError Exception Value: 'password' Exception Location: C:\Users\高琨\AppData\Local\Programs\Python\Python39\lib\site-packages\django\utils\datastructures.py, line 86, in __getitem__ Raised during: account.views.UserView Python Executable: C:\Users\高琨\AppData\Local\Programs\Python\Python39\python.exe Python Version: 3.9.11 Python Path: ['C:\\Users\\高琨\\Desktop\\backend', 'C:\\Users\\高琨\\AppData\\Local\\Programs\\Python\\Python39\\python39.zip', 'C:\\Users\\高琨\\AppData\\Local\\Programs\\Python\\Python39\\DLLs', 'C:\\Users\\高琨\\AppData\\Local\\Programs\\Python\\Python39\\lib', 'C:\\Users\\高琨\\AppData\\Local\\Programs\\Python\\Python39', 'C:\\Users\\高琨\\AppData\\Local\\Programs\\Python\\Python39\\lib\\site-packages'] Server time: Tue, 24 Jun 2025 10:29:49 +0800 Traceback Switch to copy-and-paste view C:\Users\高琨\AppData\Local\Programs\Python\Python39\lib\site-packages\django\utils\datastructures.py, line 84, in __getitem__ list_ = super().__getitem__(key) … Local vars During handling of the above exception ('password'), another exception occurred: C:\Users\高琨\AppData\Local\Programs\Python\Python39\lib\site-packages\django\core\handlers\exception.py, line 55, in inner response = get_response(request) … Local vars C:\Users\高琨\AppData\Local\Programs\Python\Python39\lib\site-packages\django\core\handlers\base.py, line 197, in _get_response response = wrapped_callback(request, *callback_args, **callback_kwargs) … Local vars C:\Users\高琨\AppData\Local\Programs\Python\Python39\lib\site-packages\django\views\decorators\csrf.py, line 56, in wrapper_view return view_func(*args, **kwargs) … Local vars C:\Users\高琨\AppData\Local\Programs\Python\Python39\lib\site-packages\rest_framework\viewsets.py, line 124, in view return self.dispatch(request, *args, **kwargs) … Local vars C:\Users\高琨\AppData\Local\Programs\Python\Python39\lib\site-packages\rest_framework\views.py, line 509, in dispatch response = self.handle_exception(exc) … Local vars C:\Users\高琨\AppData\Local\Programs\Python\Python39\lib\site-packages\rest_framework\views.py, line 469, in handle_exception self.raise_uncaught_exception(exc) … Local vars C:\Users\高琨\AppData\Local\Programs\Python\Python39\lib\site-packages\rest_framework\views.py, line 480, in raise_uncaught_exception raise exc … Local vars C:\Users\高琨\AppData\Local\Programs\Python\Python39\lib\site-packages\rest_framework\views.py, line 506, in dispatch response = handler(request, *args, **kwargs) … Local vars C:\Users\高琨\Desktop\backend\account\views.py, line 31, in login password = request.data['password'] … Local vars C:\Users\高琨\AppData\Local\Programs\Python\Python39\lib\site-packages\django\utils\datastructures.py, line 86, in __getitem__ raise MultiValueDictKeyError(key) … Local vars Request information USER AnonymousUser GET No GET data POST Variable Value csrfmiddlewaretoken 'DWg42eYqodHAyGvU8iq7SW01Agw6SWsrGqn2RNRtENkZgyesArpAfiWcxFAkniwR' last_login '' first_name '琨' last_name '高' date_joined '' email '3537676579@qq.com' desc '啊大苏打' mobile '13698551543' gender '' FILES Variable Value avatar <InMemoryUploadedFile: 屏幕截图 2025-05-16 181140.png (image/png)> COOKIES Variable Value csrftoken '********************' META Variable Value ALLUSERSPROFILE 'C:\\ProgramData' APPDATA 'C:\\Users\\高琨\\AppData\\Roaming' CHROME_CRASHPAD_PIPE_NAME '\\\\.\\pipe\\crashpad_2004_IXNEYUSYGSDNGSXV' COLORTERM 'truecolor' COMMONPROGRAMFILES 'C:\\Program Files\\Common Files' COMMONPROGRAMFILES(X86) 'C:\\Program Files (x86)\\Common Files' COMMONPROGRAMW6432 'C:\\Program Files\\Common Files' COMPUTERNAME 'LAPTOP-SUN5G18K' COMSPEC 'C:\\WINDOWS\\system32\\cmd.exe' CONTENT_LENGTH '75110' CONTENT_TYPE 'multipart/form-data; boundary=----WebKitFormBoundaryJGK9BG3i7H6CHnvK' CSRF_COOKIE 'dEh8ZJ3dqKNzS2TICj9Dxw6l7zeoFweA' DJANGO_SETTINGS_MODULE 'core.settings' DRIVERDATA 'C:\\Windows\\System32\\Drivers\\DriverData' EFC_9700_1262719628 '1' EFC_9700_1592913036 '1' EFC_9700_2283032206 '1' EFC_9700_2775293581 '1' EFC_9700_3789132940 '1' FPS_BROWSER_APP_PROFILE_STRING 'Internet Explorer' FPS_BROWSER_USER_PROFILE_STRING 'Default' GATEWAY_INTERFACE 'CGI/1.1' HOMEDRIVE 'C:' HOMEPATH '\\Users\\高琨' HTTP_ACCEPT 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7' HTTP_ACCEPT_ENCODING 'gzip, deflate, br, zstd' HTTP_ACCEPT_LANGUAGE 'zh-CN,zh;q=0.9,en;q=0.8,en-GB;q=0.7,en-US;q=0.6' HTTP_CACHE_CONTROL 'max-age=0' HTTP_CONNECTION 'keep-alive' HTTP_COOKIE '********************' HTTP_HOST '127.0.0.1:8000' HTTP_ORIGIN 'http://127.0.0.1:8000' HTTP_REFERER 'http://127.0.0.1:8000/auth/users/' HTTP_SEC_CH_UA '"Microsoft Edge";v="137", "Chromium";v="137", "Not/A)Brand";v="24"' HTTP_SEC_CH_UA_MOBILE '?0' HTTP_SEC_CH_UA_PLATFORM '"Windows"' HTTP_SEC_FETCH_DEST 'document' HTTP_SEC_FETCH_MODE 'navigate' HTTP_SEC_FETCH_SITE 'same-origin' HTTP_SEC_FETCH_USER '?1' HTTP_UPGRADE_INSECURE_REQUESTS '1' HTTP_USER_AGENT ('Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like ' 'Gecko) Chrome/137.0.0.0 Safari/537.36 Edg/137.0.0.0') LANG 'zh_CN.UTF-8' LOCALAPPDATA 'C:\\Users\\高琨\\AppData\\Local' LOGONSERVER '\\\\LAPTOP-SUN5G18K' NPM_HOME 'C:\\Program Files\\nodejs\\node_global' NUMBER_OF_PROCESSORS '16' NVM_HOME 'E:\\nvm' NVM_SYMLINK 'C:\\nvm4w\\nodejs' ONEDRIVE 'C:\\Users\\高琨\\OneDrive' ORIGINAL_XDG_CURRENT_DESKTOP 'undefined' OS 'Windows_NT' PATH ('E:\\bin\\;C:\\Windows\\system32;C:\\Windows;C:\\Windows\\System32\\Wbem;C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\;C:\\Windows\\System32\\OpenSSH\\;C:\\Windows\\system32\\config\\systemprofile\\AppData\\Local\\Microsoft\\WindowsApps;C:\\windows\\system32\\HWAudioDriver\\;C:\\WINDOWS\\system32;C:\\WINDOWS;C:\\WINDOWS\\System32\\Wbem;C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\;C:\\WINDOWS\\System32\\OpenSSH\\;E:\\nvm;C:\\nvm4w\\nodejs;C:\\Program ' 'Files\\dotnet\\;C:\\Program Files\\nodejs\\;C:\\Program ' 'Files\\nodejs\\node_global;C:\\Windows\\System32\\node_modules\\yarn\\bin;D:\\yarn_global\\bin;F:\\;C:\\Program ' 'Files ' '(x86)\\Tencent\\微信web开发者工具\\dll;C:\\Users\\高琨\\AppData\\Local\\Microsoft\\WindowsApps\\python3.exe;D:\\phpstudy_pro\\Extensions\\php\\php7.3.4nts;D:\\phpstudy_pro\\Extensions\\composer2.5.8;C:\\Program ' 'Files (x86)\\NetSarang\\Xftp ' '8\\;C:\\Users\\高琨\\AppData\\Local\\Programs\\Python\\Python39\\Scripts\\;C:\\Users\\高琨\\AppData\\Local\\Programs\\Python\\Python39\\;C:\\Users\\高琨\\AppData\\Local\\Programs\\Python\\Launcher\\;C:\\Users\\高琨\\AppData\\Local\\Microsoft\\WindowsApps;C:\\Users\\高琨\\AppData\\Local\\Programs\\Microsoft ' 'VS Code\\bin;E:\\nvm;C:\\nvm4w\\nodejs;C:\\Users\\高琨\\AppData\\Roaming\\npm') PATHEXT '.COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC;.CPL' PATH_INFO '/auth/users/' PROCESSOR_ARCHITECTURE 'AMD64' PROCESSOR_IDENTIFIER 'Intel64 Family 6 Model 154 Stepping 3, GenuineIntel' PROCESSOR_LEVEL '6' PROCESSOR_REVISION '9a03' PROGRAMDATA 'C:\\ProgramData' PROGRAMFILES 'C:\\Program Files' PROGRAMFILES(X86) 'C:\\Program Files (x86)' PROGRAMW6432 'C:\\Program Files' PSMODULEPATH ('C:\\Users\\高琨\\Documents\\WindowsPowerShell\\Modules;C:\\Program ' 'Files\\WindowsPowerShell\\Modules;C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules') PUBLIC 'C:\\Users\\Public' QUERY_STRING '' REMOTE_ADDR '127.0.0.1' REMOTE_HOST '' REQUEST_METHOD 'POST' RUN_MAIN 'true' SCRIPT_NAME '' SERVER_NAME '127.0.0.1' SERVER_PORT '8000' SERVER_PROTOCOL 'HTTP/1.1' SERVER_SOFTWARE 'WSGIServer/0.2' SESSIONNAME 'Console' SYSTEMDRIVE 'C:' SYSTEMROOT 'C:\\WINDOWS' TEMP 'C:\\Users\\高琨\\AppData\\Local\\Temp' TERM_PROGRAM 'vscode' TERM_PROGRAM_VERSION '1.101.1' TMP 'C:\\Users\\高琨\\AppData\\Local\\Temp' USERDOMAIN 'LAPTOP-SUN5G18K' USERDOMAIN_ROAMINGPROFILE 'LAPTOP-SUN5G18K' USERNAME '高琨' USERPROFILE 'C:\\Users\\高琨' VSCODE_INJECTION '1' VSCODE_NONCE '71bb0211-da42-4580-bb3d-e761a3af6e04' VSCODE_STABLE '1' WINDIR 'C:\\WINDOWS' ZES_ENABLE_SYSMAN '1' wsgi.errors <_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'> wsgi.file_wrapper <class 'wsgiref.util.FileWrapper'> wsgi.input <django.core.handlers.wsgi.LimitedStream object at 0x000001EBE9AE46D0> wsgi.multiprocess False wsgi.multithread True wsgi.run_once False wsgi.url_scheme 'http' wsgi.version (1, 0) Settings Using settings module core.settings Setting Value ABSOLUTE_URL_OVERRIDES {} ADMINS [] ALLOWED_HOSTS ['*'] APPEND_SLASH True AUTHENTICATION_BACKENDS ['django.contrib.auth.backends.ModelBackend'] AUTH_PASSWORD_VALIDATORS '********************' AUTH_USER_MODEL 'account.User' BASE_DIR WindowsPath('C:/Users/高琨/Desktop/backend') CACHES {'default': {'BACKEND': 'django.core.cache.backends.locmem.LocMemCache'}} CACHE_MIDDLEWARE_ALIAS 'default' CACHE_MIDDLEWARE_KEY_PREFIX '********************' CACHE_MIDDLEWARE_SECONDS 600 CORS_ALLOW_ALL_ORIGINS True CSRF_COOKIE_AGE 31449600 CSRF_COOKIE_DOMAIN None CSRF_COOKIE_HTTPONLY False CSRF_COOKIE_MASKED False CSRF_COOKIE_NAME 'csrftoken' CSRF_COOKIE_PATH '/' CSRF_COOKIE_SAMESITE 'Lax' CSRF_COOKIE_SECURE False CSRF_FAILURE_VIEW 'django.views.csrf.csrf_failure' CSRF_HEADER_NAME 'HTTP_X_CSRFTOKEN' CSRF_TRUSTED_ORIGINS [] CSRF_USE_SESSIONS False DATABASES {'default': {'ATOMIC_REQUESTS': False, 'AUTOCOMMIT': True, 'CONN_HEALTH_CHECKS': False, 'CONN_MAX_AGE': 0, 'ENGINE': 'django.db.backends.sqlite3', 'HOST': '', 'NAME': WindowsPath('C:/Users/高琨/Desktop/backend/db.sqlite3'), 'OPTIONS': {}, 'PASSWORD': '********************', 'PORT': '', 'TEST': {'CHARSET': None, 'COLLATION': None, 'MIGRATE': True, 'MIRROR': None, 'NAME': None}, 'TIME_ZONE': None, 'USER': ''}} DATABASE_ROUTERS [] DATA_UPLOAD_MAX_MEMORY_SIZE 2621440 DATA_UPLOAD_MAX_NUMBER_FIELDS 1000 DATA_UPLOAD_MAX_NUMBER_FILES 100 DATETIME_FORMAT 'N j, Y, P' DATETIME_INPUT_FORMATS ['%Y-%m-%d %H:%M:%S', '%Y-%m-%d %H:%M:%S.%f', '%Y-%m-%d %H:%M', '%m/%d/%Y %H:%M:%S', '%m/%d/%Y %H:%M:%S.%f', '%m/%d/%Y %H:%M', '%m/%d/%y %H:%M:%S', '%m/%d/%y %H:%M:%S.%f', '%m/%d/%y %H:%M'] DATE_FORMAT 'N j, Y' DATE_INPUT_FORMATS ['%Y-%m-%d', '%m/%d/%Y', '%m/%d/%y', '%b %d %Y', '%b %d, %Y', '%d %b %Y', '%d %b, %Y', '%B %d %Y', '%B %d, %Y', '%d %B %Y', '%d %B, %Y'] DEBUG True DEBUG_PROPAGATE_EXCEPTIONS False DECIMAL_SEPARATOR '.' DEFAULT_AUTO_FIELD 'django.db.models.BigAutoField' DEFAULT_CHARSET 'utf-8' DEFAULT_EXCEPTION_REPORTER 'django.views.debug.ExceptionReporter' DEFAULT_EXCEPTION_REPORTER_FILTER 'django.views.debug.SafeExceptionReporterFilter' DEFAULT_FILE_STORAGE 'django.core.files.storage.FileSystemStorage' DEFAULT_FROM_EMAIL 'webmaster@localhost' DEFAULT_INDEX_TABLESPACE '' DEFAULT_TABLESPACE '' DISALLOWED_USER_AGENTS [] EMAIL_BACKEND 'django.core.mail.backends.smtp.EmailBackend' EMAIL_HOST 'localhost' EMAIL_HOST_PASSWORD '********************' EMAIL_HOST_USER '' EMAIL_PORT 25 EMAIL_SSL_CERTFILE None EMAIL_SSL_KEYFILE '********************' EMAIL_SUBJECT_PREFIX '[Django] ' EMAIL_TIMEOUT None EMAIL_USE_LOCALTIME False EMAIL_USE_SSL False EMAIL_USE_TLS False FILE_UPLOAD_DIRECTORY_PERMISSIONS None FILE_UPLOAD_HANDLERS ['django.core.files.uploadhandler.MemoryFileUploadHandler', 'django.core.files.uploadhandler.TemporaryFileUploadHandler'] FILE_UPLOAD_MAX_MEMORY_SIZE 2621440 FILE_UPLOAD_PERMISSIONS 420 FILE_UPLOAD_TEMP_DIR None FIRST_DAY_OF_WEEK 0 FIXTURE_DIRS [] FORCE_SCRIPT_NAME None FORMAT_MODULE_PATH None FORM_RENDERER 'django.forms.renderers.DjangoTemplates' IGNORABLE_404_URLS [] INSTALLED_APPS ['django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'rest_framework', 'corsheaders', 'account'] INTERNAL_IPS [] LANGUAGES [('af', 'Afrikaans'), ('ar', 'Arabic'), ('ar-dz', 'Algerian Arabic'), ('ast', 'Asturian'), ('az', 'Azerbaijani'), ('bg', 'Bulgarian'), ('be', 'Belarusian'), ('bn', 'Bengali'), ('br', 'Breton'), ('bs', 'Bosnian'), ('ca', 'Catalan'), ('ckb', 'Central Kurdish (Sorani)'), ('cs', 'Czech'), ('cy', 'Welsh'), ('da', 'Danish'), ('de', 'German'), ('dsb', 'Lower Sorbian'), ('el', 'Greek'), ('en', 'English'), ('en-au', 'Australian English'), ('en-gb', 'British English'), ('eo', 'Esperanto'), ('es', 'Spanish'), ('es-ar', 'Argentinian Spanish'), ('es-co', 'Colombian Spanish'), ('es-mx', 'Mexican Spanish'), ('es-ni', 'Nicaraguan Spanish'), ('es-ve', 'Venezuelan Spanish'), ('et', 'Estonian'), ('eu', 'Basque'), ('fa', 'Persian'), ('fi', 'Finnish'), ('fr', 'French'), ('fy', 'Frisian'), ('ga', 'Irish'), ('gd', 'Scottish Gaelic'), ('gl', 'Galician'), ('he', 'Hebrew'), ('hi', 'Hindi'), ('hr', 'Croatian'), ('hsb', 'Upper Sorbian'), ('hu', 'Hungarian'), ('hy', 'Armenian'), ('ia', 'Interlingua'), ('id', 'Indonesian'), ('ig', 'Igbo'), ('io', 'Ido'), ('is', 'Icelandic'), ('it', 'Italian'), ('ja', 'Japanese'), ('ka', 'Georgian'), ('kab', 'Kabyle'), ('kk', 'Kazakh'), ('km', 'Khmer'), ('kn', 'Kannada'), ('ko', 'Korean'), ('ky', 'Kyrgyz'), ('lb', 'Luxembourgish'), ('lt', 'Lithuanian'), ('lv', 'Latvian'), ('mk', 'Macedonian'), ('ml', 'Malayalam'), ('mn', 'Mongolian'), ('mr', 'Marathi'), ('ms', 'Malay'), ('my', 'Burmese'), ('nb', 'Norwegian Bokmål'), ('ne', 'Nepali'), ('nl', 'Dutch'), ('nn', 'Norwegian Nynorsk'), ('os', 'Ossetic'), ('pa', 'Punjabi'), ('pl', 'Polish'), ('pt', 'Portuguese'), ('pt-br', 'Brazilian Portuguese'), ('ro', 'Romanian'), ('ru', 'Russian'), ('sk', 'Slovak'), ('sl', 'Slovenian'), ('sq', 'Albanian'), ('sr', 'Serbian'), ('sr-latn', 'Serbian Latin'), ('sv', 'Swedish'), ('sw', 'Swahili'), ('ta', 'Tamil'), ('te', 'Telugu'), ('tg', 'Tajik'), ('th', 'Thai'), ('tk', 'Turkmen'), ('tr', 'Turkish'), ('tt', 'Tatar'), ('udm', 'Udmurt'), ('uk', 'Ukrainian'), ('ur', 'Urdu'), ('uz', 'Uzbek'), ('vi', 'Vietnamese'), ('zh-hans', 'Simplified Chinese'), ('zh-hant', 'Traditional Chinese')] LANGUAGES_BIDI ['he', 'ar', 'ar-dz', 'ckb', 'fa', 'ur'] LANGUAGE_CODE 'zh-hans' LANGUAGE_COOKIE_AGE None LANGUAGE_COOKIE_DOMAIN None LANGUAGE_COOKIE_HTTPONLY False LANGUAGE_COOKIE_NAME 'django_language' LANGUAGE_COOKIE_PATH '/' LANGUAGE_COOKIE_SAMESITE None LANGUAGE_COOKIE_SECURE False LOCALE_PATHS [] LOGGING {} LOGGING_CONFIG 'logging.config.dictConfig' LOGIN_REDIRECT_URL '/accounts/profile/' LOGIN_URL '/accounts/login/' LOGOUT_REDIRECT_URL None MANAGERS [] MEDIA_ROOT 'C:/Users/高琨/Desktop/backend/media' MEDIA_URL '/media/' MESSAGE_STORAGE 'django.contrib.messages.storage.fallback.FallbackStorage' MIDDLEWARE ['corsheaders.middleware.CorsMiddleware', 'django.middleware.security.SecurityMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware'] MIGRATION_MODULES {} MONTH_DAY_FORMAT 'F j' NUMBER_GROUPING 0 PASSWORD_HASHERS '********************' PASSWORD_RESET_TIMEOUT '********************' PREPEND_WWW False REST_FRAMEWORK {'DEFAULT_AUTHENTICATION_CLASSES': ('rest_framework_simplejwt.authentication.JWTAuthentication',), 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination', 'DEFAULT_PERMISSION_CLASSES': 'rest_framework.permissions.IsAuthenticated', 'NON_FIELD_ERRORS_KEY': '********************', 'PAGE_SIZE': 3} ROOT_URLCONF 'core.urls' SECRET_KEY '********************' SECRET_KEY_FALLBACKS '********************' SECURE_CONTENT_TYPE_NOSNIFF True SECURE_CROSS_ORIGIN_OPENER_POLICY 'same-origin' SECURE_HSTS_INCLUDE_SUBDOMAINS False SECURE_HSTS_PRELOAD False SECURE_HSTS_SECONDS 0 SECURE_PROXY_SSL_HEADER None SECURE_REDIRECT_EXEMPT [] SECURE_REFERRER_POLICY 'same-origin' SECURE_SSL_HOST None SECURE_SSL_REDIRECT False SERVER_EMAIL 'root@localhost' SESSION_CACHE_ALIAS 'default' SESSION_COOKIE_AGE 1209600 SESSION_COOKIE_DOMAIN None SESSION_COOKIE_HTTPONLY True SESSION_COOKIE_NAME 'sessionid' SESSION_COOKIE_PATH '/' SESSION_COOKIE_SAMESITE 'Lax' SESSION_COOKIE_SECURE False SESSION_ENGINE 'django.contrib.sessions.backends.db' SESSION_EXPIRE_AT_BROWSER_CLOSE False SESSION_FILE_PATH None SESSION_SAVE_EVERY_REQUEST False SESSION_SERIALIZER 'django.contrib.sessions.serializers.JSONSerializer' SETTINGS_MODULE 'core.settings' SHORT_DATETIME_FORMAT 'm/d/Y P' SHORT_DATE_FORMAT 'm/d/Y' SIGNING_BACKEND 'django.core.signing.TimestampSigner' SILENCED_SYSTEM_CHECKS [] SIMPLE_JWT {'ACCESS_TOKEN_LIFETIME': '********************', 'AUTH_HEADER_TYPES': ('Bearer',), 'REFRESH_TOKEN_LIFETIME': '********************', 'SIGNING_KEY': '********************'} STATICFILES_DIRS [] STATICFILES_FINDERS ['django.contrib.staticfiles.finders.FileSystemFinder', 'django.contrib.staticfiles.finders.AppDirectoriesFinder'] STATICFILES_STORAGE 'django.contrib.staticfiles.storage.StaticFilesStorage' STATIC_ROOT 'C:\\Users\\高琨\\Desktop\\backend\\static' STATIC_URL '/static/' STORAGES {'default': {'BACKEND': 'django.core.files.storage.FileSystemStorage'}, 'staticfiles': {'BACKEND': 'django.contrib.staticfiles.storage.StaticFilesStorage'}} TEMPLATES [{'APP_DIRS': True, 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'OPTIONS': {'context_processors': ['django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages']}}] TEST_NON_SERIALIZED_APPS [] TEST_RUNNER 'django.test.runner.DiscoverRunner' THOUSAND_SEPARATOR ',' TIME_FORMAT 'P' TIME_INPUT_FORMATS ['%H:%M:%S', '%H:%M:%S.%f', '%H:%M'] TIME_ZONE 'Asia/Shanghai' USE_DEPRECATED_PYTZ False USE_I18N True USE_L10N True USE_THOUSAND_SEPARATOR False USE_TZ False USE_X_FORWARDED_HOST False USE_X_FORWARDED_PORT False WSGI_APPLICATION 'core.wsgi.application' X_FRAME_OPTIONS 'DENY' YEAR_MONTH_FORMAT 'F Y'
最新发布
06-25
我创建了一个django drf项目,里面封装了一些函数,和规范,函数是class SearchableListModelMixinUp(viewsets.ModelViewSet): time_range_fields = [] def list(self, request, *args, **kwargs): query_params = request.query_params serializer_fields = set(self.get_serializer().fields.keys()) query = Q() # 普通字段模糊搜索(排除时间范围字段) for field, value in query_params.items(): if field in serializer_fields and field not in self.time_range_fields and value: query.add(Q(**{f'{field}__icontains': value}), Q.AND) # 时间范围过滤 for time_field in self.time_range_fields: time_values = query_params.getlist(f'{time_field}[]') if time_values and len(time_values) == 2: start_date = parse_datetime(time_values[0]) end_date = parse_datetime(time_values[1]) if start_date and end_date: start_date = make_aware(start_date) end_date = make_aware(end_date) query.add(Q(**{f'{time_field}__range': (start_date, end_date)}), Q.AND) # 查询和排序 queryset = self.get_queryset().filter(query).order_by('id') # 默认按 ID 排序 page = self.paginate_queryset(queryset) if page is not None: serializer = self.get_serializer(page, many=True) return self.get_paginated_response(serializer.data) serializer = self.get_serializer(queryset, many=True) return Response(serializer.data, status=status.HTTP_200_OK) 创建接口规范是class PermissionViewSet(viewsets.ModelViewSet): queryset = Permission.objects.all() serializer_class = PermissionSerializer pagination_class = None # 禁用分页器 # permission_classes = [permissions.IsAdminUser] 或者class UserMenuView(APIView): authentication_classes = [JWTAuthentication] permission_classes = [IsAuthenticated] def get(self, request): user = request.user # 获取用户的角色 roles = UserRole.objects.filter(user=user).values_list('role', flat=True) # 获取用户的角色名称 roles_names = UserRole.objects.filter(user=user).select_related('role').values_list('role__name', flat=True) # 将查询结果转换为列表 roles_list = list(roles_names) # 获取这些角色对应的权限 permissions = RolePermission.objects.filter(role__in=roles).values( 'permission__id', 'permission__name', 'permission__codename', 'permission__parent_id', 'role__name' # 添加 parent_id ).distinct() return Response({ 'roles': roles_list, 'menu': list(permissions) }) 写个规范文档
03-13
<think>好的,我现在需要帮用户写一个规范文档,针对他们创建的Django DRF项目中的封装函数和接口规范。首先,我得仔细看看用户提供的代码,理解他们的结构和意图。 用户提到了一个SearchableListModelMixinUp类,继承自ModelViewSet,重写了list方法。这里主要实现了两个功能:普通字段的模糊搜索和时间范围过滤。还有PermissionViewSet和UserMenuView这两个类,分别处理权限和用户菜单的获取。 接下来,我需要把这些代码的功能整理成规范文档。规范文档通常包括概述、使用方式、注意事项等部分。用户可能希望其他开发人员按照这个规范来编写接口,所以需要结构清晰,步骤明确。 首先,概述部分要说明这个文档的目的,适用于哪些场景,比如基于DRF的后端接口开发。然后分模块说明,每个模块的功能、使用方法和示例。比如SearchableListModelMixinUp用于列表接口的搜索和过滤,PermissionViewSet用于权限管理,UserMenuView获取用户菜单权限。 在写每个模块的时候,要详细说明如何继承、需要定义的属性(如time_range_fields),以及接口的请求参数和响应格式。例如,普通字段模糊搜索是通过查询参数传递字段名和值,时间范围过滤使用字段名加[]来传递开始和结束时间。 还要注意权限设置,比如PermissionViewSet禁用了分页,UserMenuView使用了JWT认证和IsAuthenticated权限。这些细节需要在文档中明确指出,避免其他开发者误用。 另外,需要提到注意事项,比如时间字段需要正确格式化,角色权限的查询使用了distinct()来去重,确保序列化器字段与模型一致。这些都是在实际开发中容易出错的地方,提前说明可以减少问题。 最后,规范文档的格式要美观,使用适当的标题和子标题,代码部分用代码块标出,参数和示例用列表展示。确保其他开发者能够快速理解并遵循这些规范。 检查是否有遗漏的部分,比如分页器的禁用、认证类的使用,以及响应数据结构是否明确。确保所有关键点都涵盖在内,语言简洁明了,符合用户的要求。</think>以下是为您的Django DRF项目编写的接口规范文档,采用结构化格式呈现: # REST API 开发规范文档 ## 一、混合类使用规范 (`SearchableListModelMixinUp`) ### 1. 功能说明 - 实现列表接口的**组合查询**功能 - 支持普通字段模糊搜索 + 时间范围过滤 - 默认按ID升序排序 ### 2. 继承方式 ```python class YourViewSet(SearchableListModelMixinUp, viewsets.ModelViewSet): # 必须定义字段 time_range_fields = ['create_time', 'update_time'] # 时间范围字段示例 serializer_class = YourSerializer queryset = YourModel.objects.all() ``` ### 3. 接口参数规范 | 参数类型 | 格式示例 | 说明 | |----------------|---------------------------|-----------------------------| | 普通字段 | `?name=test&code=A001` | 字段名需与serializer定义一致 | | 时间范围字段 | `?create_time[]=2023-01-01&create_time[]=2023-12-31` | 必须使用数组形式传参,精确到毫秒 | ### 4. 响应格式 ```json { "count": 100, "next": "http://api.example.com/items/?page=2", "previous": null, "results": [...] } ``` ## 二、权限管理规范 (`PermissionViewSet`) ### 1. 基础配置 ```python class PermissionViewSet(viewsets.ModelViewSet): queryset = Permission.objects.all() serializer_class = PermissionSerializer pagination_class = None # 强制禁用分页 # permission_classes = [permissions.IsAdminUser] # 按需启用 ``` ### 2. 安全要求 - 必须启用权限验证(建议使用JWT) - 管理接口应限制为管理员访问 ## 三、菜单权限接口规范 (`UserMenuView`) ### 1. 认证配置 ```python class UserMenuView(APIView): authentication_classes = [JWTAuthentication] # JWT认证 permission_classes = [IsAuthenticated] # 登录验证 ``` ### 2. 响应数据结构 ```json { "roles": ["管理员", "运营人员"], "menu": [ { "permission__id": 1, "permission__name": "用户管理", "permission__codename": "user_manage", "permission__parent_id": null, "role__name": "管理员" } ] } ``` ## 四、通用开发规范 1. **时间处理规范** - 所有时间字段必须使用ISO 8601格式:`YYYY-MM-DDTHH:MM:SS.sssZ` - 使用`make_aware()`处理时区问题 2. **查询优化** ```python # 使用select_related优化关联查询 UserRole.objects.filter(user=user).select_rel
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值