120 lines
6.4 KiB
Python
120 lines
6.4 KiB
Python
# +======================================================================
|
||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||
# +----------------------------------------------------------------------
|
||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||
# +----------------------------------------------------------------------
|
||
# | 开源协议: Apache-2.0
|
||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||
# +----------------------------------------------------------------------
|
||
# | 官方网站: https://www.djangoadmin.cn
|
||
# +----------------------------------------------------------------------
|
||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||
# +======================================================================
|
||
# | 版权和免责声明:
|
||
# | 一、知识产权声明
|
||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||
# | 二、使用限制与禁止条款
|
||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||
# | 三、责任豁免
|
||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||
# | 四、违约与法律责任
|
||
# | 如发现任何违反本声明的行为，本团队有权：
|
||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||
# | 五、许可范围说明
|
||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||
# | 成的一切经济损失及商誉损害。
|
||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||
# | 许可协议》附件为准。
|
||
# +======================================================================
|
||
|
||
from django.urls import path
|
||
|
||
from application.config_item import views
|
||
|
||
"""
|
||
配置项模块路由配置
|
||
=============================================================
|
||
|
||
URL端点概览：
|
||
------------------------------------------------------------------------
|
||
| 功能说明 | 请求方法 | URL路径 | 视图类 |
|
||
|-----------------|----------|-----------------------------|--------------------------|
|
||
| 分页查询 | GET | /config_item/page | ConfigDataPageView |
|
||
| 详情查询 | GET | /config_item/detail/<id> | ConfigDataDetailView |
|
||
| 添加配置项 | POST | /config_item/add | ConfigDataAddView |
|
||
| 更新配置项 | PUT | /config_item/update | ConfigDataUpdateView |
|
||
| 删除配置项 | DELETE | /config_item/delete/<ids> | ConfigDataDeleteView |
|
||
| 设置状态 | PUT | /config_item/status | ConfigDataStatusView |
|
||
------------------------------------------------------------------------
|
||
|
||
URL参数说明：
|
||
- config_id: int类型，配置项ID（用于查询详情）
|
||
- config_id: str类型，逗号分隔的配置项ID字符串（用于批量删除）
|
||
|
||
使用示例：
|
||
1. 分页查询：GET /api/config_item/page?pageNo=1&pageSize=10&name=系统名称
|
||
2. 详情查询：GET /api/config_item/detail/5
|
||
3. 添加配置项：POST /api/config_item/add
|
||
4. 更新配置项：PUT /api/config_item/update
|
||
5. 删除配置项：DELETE /api/config_item/delete/5,6,7
|
||
|
||
配置项类型说明：
|
||
- text: 文本类型
|
||
- number: 数字类型
|
||
- boolean: 布尔类型
|
||
- json: JSON类型
|
||
- array: 数组类型
|
||
|
||
注意事项：
|
||
- 配置项编码(code)通常作为系统调用的唯一标识，创建后不建议修改
|
||
- 配置项通常被缓存以提高访问性能，修改后可能需要刷新缓存
|
||
- 状态设置接口用于快速启用/禁用配置项，不影响配置项的其他属性
|
||
"""
|
||
|
||
# 配置项模块路由配置
|
||
urlpatterns = [
|
||
# 查询配置项分页列表
|
||
# URL: /config_item/page
|
||
# 请求方法: GET
|
||
# 功能: 获取配置项分页数据，支持按名称、编码、类型等条件筛选
|
||
path('page', views.ConfigDataPageView.as_view()),
|
||
|
||
# 查询配置项详情
|
||
# URL: /config_item/detail/<int:config_id>
|
||
# 请求方法: GET
|
||
# URL参数: config_id - 配置项ID（整数类型）
|
||
# 功能: 根据ID获取指定配置项的详细信息
|
||
path('detail/<int:config_id>', views.ConfigDataDetailView.as_view()),
|
||
|
||
# 添加配置项
|
||
# URL: /config_item/add
|
||
# 请求方法: POST
|
||
# 功能: 创建新的配置项记录，请求体需包含配置项信息（名称、编码、值、类型、排序、状态等）
|
||
path('add', views.ConfigDataAddView.as_view()),
|
||
|
||
# 更新配置项
|
||
# URL: /config_item/update
|
||
# 请求方法: PUT
|
||
# 功能: 更新现有配置项信息，请求体需包含配置项ID和更新内容
|
||
path('update', views.ConfigDataUpdateView.as_view()),
|
||
|
||
# 删除配置项
|
||
# URL: /config_item/delete/<str:config_id>
|
||
# 请求方法: DELETE
|
||
# URL参数: config_id - 配置项ID字符串，支持单个ID或逗号分隔的多个ID（如 "1,2,3"）
|
||
# 功能: 删除指定配置项（逻辑删除，设置is_delete=True）
|
||
path('delete/<str:config_id>', views.ConfigDataDeleteView.as_view()),
|
||
]
|