优化更新

DjangoAdmin_Django_EleVue/zh/volume2/url.md

@@ -17,30 +17,90 @@ application/urls.py              # 主路由
 from django.urls import path
 from application.example import views
 
+"""
+案例模块路由配置
+=============================================================
+
+URL端点概览：
+------------------------------------------------------------------------
+| 功能说明         | 请求方法 | URL路径                     | 视图类                  |
+|-----------------|----------|-----------------------------|-------------------------|
+| 分页查询        | GET      | /example/page        | ExamplePageView    |
+| 列表查询        | GET      | /example/list        | ExampleListView    |
+| 详情查询        | GET      | /example/detail/<id> | ExampleDetailView  |
+| 添加案例        | POST     | /example/add         | ExampleAddView     |
+| 更新案例        | PUT      | /example/update      | ExampleUpdateView  |
+| 删除案例        | DELETE   | /example/delete/<ids>| ExampleDeleteView  |
+| 设置状态        | PUT      | /example/status      | ExampleStatusView  |
+| 获取列表        | GET      | /example/data        | ExampleDataView |
+------------------------------------------------------------------------
+
+URL参数说明：
+- id: int类型，案例ID（用于查询详情）
+- id: str类型，逗号分隔的案例ID字符串（用于批量删除）
+
+使用示例：
+1. 分页查询：GET /api/example/page?pageNo=1&pageSize=10
+2. 列表查询：GET /api/example/list
+3. 详情查询：GET /api/example/detail/5
+4. 添加案例：POST /api/example/add
+5. 更新案例：PUT /api/example/update
+6. 删除案例：DELETE /api/example/delete/1,2,3
+7. 设置状态：PUT /api/example/status
+8. 获取列表：GET /api/example/data
+"""
+
+# 案例模块路由配置
 urlpatterns = [
     # 查询案例分页列表
+    # URL: /example/page
+    # 请求方法: GET
+    # 功能: 获取案例分页数据，支持按案例名称、案例类型、案例状态等条件筛选
     path('page', views.ExamplePageView.as_view()),
 
     # 查询案例数据列表（支持筛选）
+    # URL: /example/list
+    # 请求方法: GET
+    # 功能: 获取所有案例的列表数据，支持按条件筛选，用于下拉选择等前端组件
     path('list', views.ExampleListView.as_view()),
 
     # 查询案例详情
+    # URL: /example/detail/<int:id>
+    # 请求方法: GET
+    # URL参数: id - 案例ID（整数类型）
+    # 功能: 根据ID获取指定案例的详细信息
     path('detail/<int:id>', views.ExampleDetailView.as_view()),
 
     # 添加案例
+    # URL: /example/add
+    # 请求方法: POST
+    # 功能: 创建新的案例记录，请求体需包含案例信息（name、avatar、type、status、sort等）
     path('add', views.ExampleAddView.as_view()),
 
     # 更新案例
+    # URL: /example/update
+    # 请求方法: PUT
+    # 功能: 更新现有案例信息，请求体需包含案例ID和更新内容
     path('update', views.ExampleUpdateView.as_view()),
 
     # 删除案例
+    # URL: /example/delete/<str:id>
+    # 请求方法: DELETE
+    # URL参数: id - 案例ID字符串，支持单个ID或逗号分隔的多个ID（如 "1,2,3"）
+    # 功能: 删除指定案例（逻辑删除，设置is_delete=True）
     path('delete/<str:id>', views.ExampleDeleteView.as_view()),
 
     # 设置案例状态
+    # URL: /example/status
+    # 请求方法: PUT
+    # 功能: 更新案例的启用/禁用状态
     path('status', views.ExampleStatusView.as_view()),
 
     # 查询案例数据列表
-    path('list', views.ExampleDataView.as_view()),
+    # URL: /example/data
+    # 请求方法: GET
+    # 功能: 获取所有启用案例的列表数据，用于下拉选择等前端组件
+    path('data', views.ExampleDataView.as_view()),
 ]
 ```