def ResponseBody(self,
data,
model_name,
response_model="model",
response_code="200",
response_data="成功",
response_templates=None,
response_fileds=False,
function=None):
"""返回整个BODY
:params data : response data
:params response_model: model | response
:return : response data model
"""
models = {}
for _key in data:
if isinstance(data[_key], dict):
_fields = fields.Nested(
model=api.model(_key, self.NestedList(data[_key])))
elif isinstance(data[_key], list):
_fields = fields.List(
fields.Nested(
model=api.model(_key, self.NestedList(data[_key]))))
else:
_fields = self.__swich_fields_keys[
data[_key].__class__.__name__](data[_key],
Description=data[_key])
models[_key] = _fields
if response_fileds:
return models
if response_model == "response":
return api.response(response_code,
response_data,
model=api.model(model_name, models))
# if function:
# api.doc(body=api.model(model_name, models))(function)
return api.doc(body=api.model(model_name, models))
from server import api
request_jobs_list_param = api.doc(params={
'job_name': '职位名称',
'region': '地区筛选',
'time_scale': '发布时间筛选,0:不限,1:一天以内,2:三天以内,3:七天以内,4:十五天以内,5:一个月以内',
'page': '页数',
},
description='货源统计列表查询参数')
# -*- coding: utf-8 -*-
from server import api
from flask_restplus import fields
request_system_message_list_get = api.doc(params={
'page': '页数',
'limit': '条数',
})
request_system_message_post = api.doc(body=api.model('request_system_message_post', {
'title': fields.String(description='消息标题'),
'content': fields.String(description='消息内容'),
'msg_type': fields.Integer(description='消息类型: 1.手动发布, 2自动发布'),
'push_role': fields.Integer(description='推送角色: 0.全部,1.后台用户,2.区镇合伙人,3.网点管理员,4.城市经理')
}))
request_system_message_put = api.doc(body=api.model('request_system_message_put', {
'title': fields.String(description='消息标题'),
'content': fields.String(description='消息内容'),
'msg_type': fields.Integer(description='消息类型: 1.手动发布, 2自动发布'),
'push_role': fields.Integer(description='推送角色: 0.全部,1.后台用户,2.区镇合伙人,3.网点管理员,4.城市经理')
}))
request_user_message_list_get = api.doc(params={
'user_name': '用户名',
'page': '页数',
'limit': '条数',
})
request_user_message_read_put = api.doc(body=api.model('request_user_message_read_post', {
# -*- coding:utf-8 -*-
# author=hexm
from server import api
request_user_list_param = api.doc(params={
'user_name': '用户名,默认:空',
'mobile': '手机号,默认:空',
'reference_mobile': '推荐人手机,默认:空',
'download_channel': '下载渠道,默认:空',
'from_channel': '注册渠道,默认:空',
'is_referenced': '推荐注册,0:全部,1:有,2:无,默认:0',
'region_id': '常驻地, 0:全部,其他地区用行政代码,默认:0',
'role_type': '注册角色,0:全部,1:货主,2:司机,3:物流公司,默认:0',
'role_auth': '认证角色,0:全部,1:货主,2:司机,3:物流公司,默认:0',
'is_actived':
'是否活跃,0:全部,1:活跃(连续登录天数>1),2:一般(1-3天未登录),3:即将沉睡(4-10天未登录),4:沉睡(10天以上未登录),5:今天登录,默认:0',
'is_used': '操作过,0:全部,1:发布货源,2:接单,3:完成订单,默认:0',
'is_car_sticker': '贴车贴,0:全部,1:有,2:无,默认:0',
'last_login_start_time': '最后登录开始时间',
'last_login_end_time': '最后登录结束时间',
'register_start_time': '注册开始时间',
'register_end_time': '注册结束时间',
'page': '页数',
'limit': '条数'
},
description='用户统计列表查询参数')
request_user_statistic_param = api.doc(params={
'start_time': '开始日期(时间戳),默认:7天前',
'end_time': '结束日期(时间戳),默认:昨天',
'periods': '时间周期,2:日，3:周，4:月，默认:2',
# -*- coding: utf-8 -*-
from server import api
from flask_restplus import fields
request_root_management_get = api.doc(params={
'page': '页数',
'limit': '条数',
})
request_root_management_add = api.doc(body=api.model(
'request_root_management_add', {
'mobile': fields.String(description='手机号'),
'comment': fields.String(description='用户备注'),
'user_name': fields.String(description='用户名'),
'password': fields.String(description='密码'),
'role_id': fields.List(fields.Integer, description='角色id列表'),
}))
request_root_put = api.doc(body=api.model(
'request_root_put', {
'mobile': fields.String(description='手机号'),
'comment': fields.String(description='用户备注'),
'user_name': fields.String(description='用户名'),
'password': fields.String(description='密码'),
'role_id': fields.List(fields.Integer, description='角色id列表'),
'is_active': fields.Integer(description='是否启用:1.启用;2.禁用'),
}))
request_root_role_management_add = api.doc(body=api.model(
'request_root_role_management_add', {
#!/usr/bin/python
# -*- coding:utf-8 -*-
# Copyright (c) 2016 yu.liu <*****@*****.**>
# All rights reserved
from flask_restplus import fields
from server.status import APIStatus, FeedAPIStatus
from server import api
request_user_login = api.doc(
body=api.model('request_user_login', {
'user_name': fields.String(description='用户名'),
'password': fields.String(description='密码'),
'role': fields.Integer(description='角色：1管理员，4城市经理')
},
description='用户登录请求参数'))
response_user_login_success = response_success = api.response(
200, '成功',
api.model(
'response_success', {
'state':
fields.Integer(description=str(APIStatus.Ok)),
'msg':
fields.String(description=FeedAPIStatus.Decriptions[APIStatus.Ok]),
}))
from server import api
request_jobs_list_param = api.doc(params={
'job_name': '职位名称',
'region': '地区筛选',
'time_scale': '发布时间筛选,0:不限,1:一天以内,2:三天以内,3:七天以内,4:十五天以内,5:一个月以内',
'page': '页数',
},
description='职位统计列表查询参数')
request_jobs_pie_params = api.doc(params={
'search_name': '职位名称',
},
description='职位地区分布查询参数')
request_jobs_salary_pie_params = api.doc(params={
'search_name': '职位名称',
'region': '地区筛选',
},
description='职位薪水分布查询参数')
request_jobs_detail_params = api.doc(params={
'search_name': '职位名称',
'region': '地区筛选',
},
description='职位薪水分布查询参数')
from server import api
price_trend_param = api.doc(
params={
"from_province_id": "出发地省份",
"from_city_id": "出发地城市",
"from_county_id": "出发地区县",
"to_province_id": "目的地省份",
"to_city_id": "目的地城市",
"to_county_id": "目的地区县",
"min_mileage": "最小里程",
"max_mileage": "最大里程",
"vehicle_length": "车型",
# "pay_method": "1.线上支付;2.线下支付",
"order_status": "1.进行中;2.已完成;3.已取消",
"start_time": "开始时间",
"end_time": "结束时间",
},
description='价格趋势统计')
from flask_restplus import fields
from server import api
distribution_map_param = api.doc(params={
"dimension":
"1.按用户;2.按货源;3.按运力;4.按订单",
"filter":
"用户:1.司机/2.货主/3.物流公司;货源:1.议价/2.一口价;运力:1.小面包车/4.2米等;订单:1.议价/2.一口价",
"field":
"用户:1.累计用户数/2.新增用户数/3.累计认证数/4.登陆过/5.均有登录;"
"货源:1.货源数/2.接单数/3.取消数/4.待接单;"
"车型:1.货源所需/2.累计车辆数/3.活跃车辆数;"
"订单:1.订单数/2.完成数/3.进行中/4.已取消",
"start_time":
"开始时间",
"end_time":
"开始时间",
"region_id":
"地区id"
},
description='分布图查询参数')
goods_map_param = api.doc(params={
"goods_price_type": "0.全部;1.一口价;2.议价;",
"haul_dist": "0.全部;1.同城;2.跨城;",
"vehicle_length": "空字符串:全部;常用车型:4.2米,5.2米等",
"goods_status": "0.全部;1.待接单;2.已接单;3.已完成;4.已取消",
"special_tag": "0.全部;1.新用户",
"delivery_start_time": "开始发货时间",
"delivery_end_time": "结束发货时间",
from flask_restplus import fields
from server import api
request_business_msg_list_get = api.doc(params={
'page': '页数',
'limit': '条数',
})
request_business_msg_post = api.doc(body=api.model(
'request_business_msg_post', {
'follow_name': fields.String(description='跟进人的名字'),
'follow_result': fields.String(description='谈成或者没谈成的结果'),
}))
request_goods_list_param = api.doc(params={
'goods_id': '货源id',
'mobile': '货主手机',
'from_province_id': '发出地省份',
'from_city_id': '发出地城市',
'from_county_id': '发出地区县',
'to_province_id': '目的地省份',
'to_city_id': '目的地城市',
'to_county_id': '目的地区县',
'goods_type': '货源距离类型',
'goods_price_type': '货源价格类型',
'goods_status': '货源状态',
'is_called': '是否通话',
'vehicle_length': '车长要求',
'vehicle_type': '车型要求',
'node_id': '所属网点',
'new_goods_type': '初次下单',
'urgent_goods': '急需处理',
'is_addition': '是否加价',
'payment_method': '0:全部;1.发货人付;2.收货人付;3.省心保',
'create_start_time': '发布开始日期',
'create_end_time': '发布结束日期',
'load_start_time': '装货开始日期',
'load_end_time': '装货结束日期',
'register_start_time': '注册开始时间',
'register_end_time': '注册结束时间',
'page': '页数',
'limit': '条数',
},
description='货源统计列表查询参数')
#!/usr/bin/python
# -*- coding:utf-8 -*-
# author=hexm
from server import api
request_goods_potential_list_param = api.doc(params={
'from_province_id': '发出地省份',
'from_city_id': '发出地城市',
'from_county_id': '发出地区县',
'to_province_id': '目的地省份',
'to_city_id': '目的地城市',
'to_county_id': '目的地区县',
'goods_price_type': '货源价格类型,1:一口价,2:议价,默认:0全部',
'business': '货源业务类型:0.全部;1.整车;2.零担',
'haul_dist': '货源距离类型:0.全部;1.同城;2.跨城',
'vehicle_name': '车长要求',
'special_tag': '特殊要求:0.全部;1.新注册;2.发过货;3.完成过订单;4.没完成过订单',
'register_start_time': '注册开始时间',
'register_end_time': '注册结束时间',
'record_start_time': '记录开始时间',
'record_end_time': '记录结束时间',
'page': '页数',
'limit': '条数',
},
description='潜在货源统计列表查询参数')
request_goods_potential_distribution_trend_param = api.doc(
params={
'start_time': '开始时间',
'end_time': '结束时间',
'periods': '时间周期,2:日，3:周，4:月，默认:2',
from server import api
transport_radar_param = api.doc(params={
"start_time": "开始时间",
"end_time": "开始时间",
"region_id": "地区id",
"from_city_id": "出发地城市id",
"from_county_id": "出发地区县id",
"to_city_id": "目的地城市id",
"to_county_id": "目的地区县id",
},
description='运力趋势查询参数')
transport_list_param = api.doc(params={
"from_city_id": "出发地城市id",
"to_city_id": "目的地城市id",
"start_time": "统计开始时间,默认传当前选择日期00:00:00的时间戳",
"end_time": "统计结束时间,默认传当前时间戳",
"calc_town": "0:不计算区镇;1:计算出发地城市下所有区镇;2.计算目的地城市下所有区镇;3.同时计算出发地和目的地城市下所有区镇",
"page": "页数",
"limit": "条数",
},
description='运力列表查询参数')
# -*- coding: utf-8 -*-
from server import api
request_city_manager = api.doc(
params={
'mobile': '手机号',
'start_time': '开始日期(时间戳),默认:8天前',
'end_time': '结束日期(时间戳),默认:昨天',
})
#!/usr/bin/python
# -*- coding:utf-8 -*-
# author=hexm
from flask_restplus import fields
from server.status import APIStatus, FeedAPIStatus
from server import api
request_promote_effect_param = api.doc(params={
'user_name': '用户名,默认:空',
'mobile': '手机号,默认:空',
'goods_type': '货源类型,0:全部,1:一口价,2:议价',
'register_start_time': '注册期开始时间,默认:空',
'register_end_time': '注册日期结束时间,默认:空',
'statistic_start_time': '注册期开始时间,默认:空',
'statistic_end_time': '注册日期结束时间,默认:空',
'region_id': '用户自选地区id',
'page': '页数',
'limit': '条数'
},
description='推广统计列表查询参数')
response_promote_effect_param_success = response_success = api.response(
200, '成功',
api.model(
'response_success', {
'state':
fields.Integer(description=str(APIStatus.Ok)),
'msg':
fields.String(description=FeedAPIStatus.Decriptions[APIStatus.Ok]),
}))
'msg':
fields.String(description=FeedAPIStatus.Decriptions[APIStatus.Ok]),
}))
request_order_received_statistics_param = api.doc(params={
'start_time':
'开始日期(时间戳),默认:8天前',
'end_time':
'结束日期(时间戳),默认:昨天',
'periods':
'时间周期,2:日，3:周，4:月，默认:2',
'goods_type':
'货源类型,1:跨城,2:同城,默认:0全部',
'goods_price_type':
'货源类型,1:议价,2:一口价,默认:0全部',
'dimension':
'维度,1:按数量,2：按金额,默认:1',
'region_id':
'地区id,默认:0全部',
'comment_type':
'评价:1:好评,2:中评,3:差评,默认:0全部',
'pay_method':
'支付方式,1:未支付,2:线上支付,3:线下支付,默认:0全部',
'SXB':
'0:全部;1.需要;2.不需要;3.生效;4.未生效',
},
description='订单统计请求参数')
request_cancel_order_reason_param = api.doc(params={
'start_time': '开始时间',
'end_time': '结束时间',
from server import api
verify_vehicle_list_param = api.doc(params={
"mobile": "手机号",
"vehicle_number": "车牌号码",
"home_station_id": "常驻地id",
"vehicle_length": "车长要求",
"verify_start_time": "认证开始时间",
"verify_end_time": "认证结束时间",
"last_login_start_time": "最后登录开始时间",
"last_login_end_time": "最后登录结束时间",
"page": "页数",
"limit": "条数",
},
description='运力列表查询参数')
def request_param(self, name=None, data={}, **kwarg):
return api.doc(params=data)
from server import api
request_user_retain_statistic_param = api.doc(params={
'start_time': '开始日期(时间戳),默认:7天前',
'end_time': '结束日期(时间戳),默认:当前时间',
'periods': '时间周期,2:日，3:周，4:月，默认:2',
'user_type': '用户类型,1:货主，2:司机，3:物流公司，默认:0',
'special_tag': '1.不计算当天住处;默认:0',
'region_id': '地区id',
},
description='用户行为变化趋势查询参数')
request_user_retain_list_param = api.doc(params={
'start_date': '开始日期(字符串),默认:7天前',
'end_date': '结束日期(字符串),默认:当前时间',
'user_type': '用户类型,1:货主，2:司机，3:物流公司，默认:0',
'user_behavior': '用户行为1:登录,2:发货,3:接单,默认:1',
'region_id': '地区id',
},
description='用户行为变化趋势查询参数')
# -*- coding: utf-8 -*-
from server import api
request_city_resource_balance = api.doc(
params={
'start_time': '开始日期(时间戳),默认:8天前',
'end_time': '结束日期(时间戳),默认:昨天',
'region_id': '地区id,默认:0',
'haul_dist': '运输距离:1.同城,2.跨城,默认:0',
'goods_price_type': '货源价格类型,1:议价,2:一口价,默认:1议价'
})
request_order_list_param = api.doc(params={
'goods_type': '货源类型,1.跨城,2.同城,默认:0全部',
'goods_price_type': '货源类型,1:议价,2:一口价,默认:0全部',
'priority': '优先级,1:高,2:一般,3:默认:0全部',
'vehicle_length': '车长要求,车长id,默认:0全部',
'is_called': '是否通话：1:有,2:无,3:大于10次,默认：0全部',
'is_addition': '是否加价,1:是,2:否,默认:0全部',
'node_id': '所属网点:网点id,默认:0全部',
'spec_tag': '特殊标签,1:初次下单,默认:0无',
'mobile': '手机号',
'page': '页数',
'limit': '条数'
},
description='最新待接订单统计列表查询参数')
request_nearby_cars_param = api.doc(params={
'goods_type':
'车辆类型,1:接单线路,2:附近货车，默认:1:接单线路',
