DjangoAdmin_Flask_EleVue/src/modules/dictionary/router.py

# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 一米阳光团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 一米阳光团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意，禁止将本产品用于以下任何行为：
# | 1. 任何违反中华人民共和国法律法规的用途；
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为，本团队有权：
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================


"""
字典管理控制器模块
=============================================================

提供字典（Dict）相关的API接口，包括：
- 字典分页查询
- 字典详情查询
- 字典添加、更新、删除

所属包： application.views
依赖模块： application.services.dicts - 字典业务逻辑层
         application.middleware.check_permission - 权限校验中间件
"""
from flask import Blueprint, request

from application.middleware.check_demo import check_demo
from application.middleware.check_permission import check_permission
from src.modules.dictionary import service as dict
from src.modules.dictionary import service as dict_item
from src.common.utils.request import parse_batch_ids, parse_request_body

from src.core import response as R

dict_blue = Blueprint("dict", __name__, url_prefix="/dict")


# ============================================================
# 字典分页查询
# ============================================================


@dict_blue.route("/page", methods=["GET"])
@check_permission("sys:dict:page")
def page():
    """
    查询字典分页数据

    功能说明：
        获取字典列表的分页数据，支持关键词搜索和状态筛选。

    Returns:
        JSON: 字典分页数据，包含 records（数据列表）、total（总记录数）等
    """
    return R.ok(data=dict.get_dict_page(request.args))


# ============================================================
# 字典详情查询
# ============================================================


@dict_blue.route("/detail/<int:id>", methods=["GET"])
@check_permission("sys:dict:detail")
def detail(id):
    """
    查询字典详情

    Args:
        id: 字典ID

    Returns:
        JSON: 字典详细信息
    """
    data = dict.get_dict_detail(id)
    return R.ok(data=data)


# ============================================================
# 字典添加
# ============================================================


@dict_blue.route("/add", methods=["POST"])
@check_permission("sys:dict:add")
@check_demo
def add():
    """
    添加字典

    功能说明：
        创建新的字典记录。

    Returns:
        JSON: 操作结果
    """
    json_data, err = parse_request_body()
    if err:
        return R.failed(msg=err)
    dict.add_dict(json_data)
    return R.ok(msg="添加成功")


# ============================================================
# 字典更新
# ============================================================


@dict_blue.route("/update", methods=["PUT"])
@check_permission("sys:dict:update")
@check_demo
def update():
    """
    更新字典

    功能说明：
        修改已有的字典信息。

    Returns:
        JSON: 操作结果
    """
    json_data, err = parse_request_body()
    if err:
        return R.failed(msg=err)
    dict.update_dict(json_data)
    return R.ok(msg="更新成功")


# ============================================================
# 字典删除
# ============================================================


@dict_blue.route("/delete/<string:id>", methods=["DELETE"])
@check_permission("sys:dict:delete")
@check_demo
def delete(id):
    """
    删除字典

    Args:
        id: 字典ID（支持逗号分隔的多个ID）

    Returns:
        JSON: 操作结果
    """
    count = dict.delete_dicts(id)
    return R.ok(msg=f"本次共删除{count}条数据")


# ============================================================
# 字典批量删除
# ============================================================


@dict_blue.route("/batchDelete", methods=["DELETE"])
@check_permission("sys:dict:batch_delete")
@check_demo
def batch_delete():
    """
    批量删除字典

    功能说明：
        批量删除字典记录，支持传入ID数组。

    Request Body:
        [1, 2, 3]  # 字典ID数组

    Returns:
        JSON: 操作结果
    """
    id_str, err = parse_batch_ids()
    if err:
        return err
    count = dict.delete_dicts(id_str)
    return R.ok(msg=f"本次共删除{count}条数据")


"""
字典项数据控制器模块
=============================================================

提供字典项数据（DictItem）相关的API接口，包括：
- 字典项分页查询
- 字典项详情查询
- 字典项添加、更新、删除

所属包： application.views
依赖模块： application.services.dicts_data - 字典项业务逻辑层
         application.middleware.check_permission - 权限校验中间件
"""
dict_item_blue = Blueprint("dict_item", __name__, url_prefix="/dict/item")


# ============================================================
# 字典项分页查询
# ============================================================


@dict_item_blue.route("/page", methods=["GET"])
@check_permission("sys:dictitem:page")
def dict_item_page():
    """
    查询字典项分页数据

    功能说明：
        获取字典项列表的分页数据，支持关键词搜索和状态筛选。

    Returns:
        JSON: 字典项分页数据，包含 records（数据列表）、total（总记录数）等
    """
    return R.ok(data=dict_item.get_dict_item_page(request.args))


# ============================================================
# 字典项详情查询
# ============================================================


@dict_item_blue.route("/detail/<int:id>", methods=["GET"])
@check_permission("sys:dictitem:detail")
def dict_item_detail(id):
    """
    查询字典项详情

    Args:
        id: 字典项ID

    Returns:
        JSON: 字典项详细信息
    """
    data = dict_item.get_dict_item_detail(id)
    return R.ok(data=data)


# ============================================================
# 字典项添加
# ============================================================


@dict_item_blue.route("/add", methods=["POST"])
@check_permission("sys:dictitem:add")
@check_demo
def dict_item_add():
    """
    添加字典项

    功能说明：
        创建新的字典项记录。

    Returns:
        JSON: 操作结果
    """
    json_data, err = parse_request_body()
    if err:
        return R.failed(msg=err)
    dict_item.add_dict_item(json_data)
    return R.ok(msg="添加成功")


# ============================================================
# 字典项更新
# ============================================================


@dict_item_blue.route("/update", methods=["PUT"])
@check_permission("sys:dictitem:update")
@check_demo
def dict_item_update():
    """
    更新字典项

    功能说明：
        修改已有的字典项信息。

    Returns:
        JSON: 操作结果
    """
    json_data, err = parse_request_body()
    if err:
        return R.failed(msg=err)
    dict_item.update_dict_item(json_data)
    return R.ok(msg="更新成功")


# ============================================================
# 字典项删除
# ============================================================


@dict_item_blue.route("/delete/<string:id>", methods=["DELETE"])
@check_permission("sys:dictitem:delete")
@check_demo
def dict_item_delete(id):
    """
    删除字典项

    Args:
        id: 字典项ID（支持逗号分隔的多个ID）

    Returns:
        JSON: 操作结果
    """
    count = dict_item.delete_dict_items(id)
    return R.ok(msg=f"本次共删除{count}条数据")


# ============================================================
# 字典项批量删除
# ============================================================


@dict_item_blue.route("/batchDelete", methods=["DELETE"])
@check_permission("sys:dictitem:batch_delete")
@check_demo
def dict_item_batch_delete():
    """
    批量删除字典项

    功能说明：
        批量删除字典项记录，支持传入ID数组。

    Request Body:
        [1, 2, 3]  # 字典项ID数组

    Returns:
        JSON: 操作结果
    """
    id_str, err = parse_batch_ids()
    if err:
        return err
    count = dict_item.delete_dict_items(id_str)
    return R.ok(msg=f"本次共删除{count}条数据")