配置参数¶
Django Cool 在 Django 中的配置都在 DJANGO_COOL 中。如：在 settings.py 中设置：
DJANGO_COOL = {
'API_ERROR_CODES': (
('ERR_TEST1', (10001, 'test1错误码')),
('ERR_TEST2', (10002, 'test2错误码')),
('ERR_TEST3', (10003, 'test3错误码')),
),
}
Admin¶
cool.admin 配置
ADMIN_AUTOCOMPLETE_CHECK_PERM¶
默认值： True
自动提示组件是否判断读权限，设置为 True 用户需要有读权限才能在下拉组件中列出数据，设置为 False 只需要登陆就可以列出数据
ADMIN_SITE_REGISTER_FILTER_FUNCTION¶
默认值： None
admin 注册 model 通用参数处理函数
def site_register_filter(model_class, *, admin_class, site, **options):
# 通用 options 处理
return options
APIView¶
cool.views 相关配置
API_SUCCESS_WITH_CODE_MSG¶
默认值： True
返回成功时，返回结果是否带 code message data 一层, 设置为``False``成功是时只返回``data``中内容
API_ERROR_CODES¶
默认值： ()
自定义错误码列表, 如settings中设置如下后
DJANGO_COOL = {
'API_ERROR_CODES': (
('ERR_TEST1', (10001, 'test1错误码')),
('ERR_TEST2', (10002, 'test2错误码')),
('ERR_TEST3', (10003, 'test3错误码')),
),
}
可以使用如下代码使用
from cool.views import ErrorCode
print(ErrorCode.ERR_TEST1)
print(ErrorCode.ERR_TEST2.code)
print(ErrorCode.ERR_TEST3.desc)
API_RESPONSE_DICT_FUNCTION¶
默认值： 'cool.views.response.get_response_dict'
组装返回结果函数
def get_response_dict(code, message, data, success_with_code_msg, status_code, response_data, **kwargs):
if not success_with_code_msg and code == ErrorCode.SUCCESS:
return data
else:
return {
cool_settings.API_DEFAULT_CODE_KEY: code,
cool_settings.API_DEFAULT_MESSAGE_KEY: message,
cool_settings.API_DEFAULT_DATA_KEY: data,
}