README.md.vm 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. # {{ table.function_name }}
  2. ## 简介
  3. {% if table.remark != '' %}{{ table.remark }}{% else %}{{ table.function_name }}{% endif %}
  4. ## 联系方式
  5. - 作者:{{ table.function_author }}
  6. - 邮箱:example@example.com
  7. ## 功能说明
  8. 该模块包含以下主要功能:
  9. 1. {{ table.function_name }}信息的增删改查操作
  10. 2. 支持分页查询和条件筛选
  11. 3. 提供RESTful API接口
  12. 4. 基于角色的访问控制(RBAC)
  13. ## 数据库设计
  14. ### 表名
  15. {{ table.table_name }}
  16. ### 表结构
  17. {% for column in table.columns %}
  18. - {{ column.column_name }} ({{ column.column_type }}): {{ column.column_comment }}
  19. {% endfor %}
  20. ## API接口
  21. | 接口名称 | 请求方式 | 接口地址 | 说明 |
  22. |---------|---------|---------|------|
  23. | 查询列表 | GET | /{{ table.module_name }}/{{ table.business_name }}/list | 分页查询{{ table.function_name }}列表 |
  24. | 查询详情 | GET | /{{ table.module_name }}/{{ table.business_name }}/{id} | 根据ID查询{{ table.function_name }}详情 |
  25. | 新增数据 | POST | /{{ table.module_name }}/{{ table.business_name }} | 新增一条{{ table.function_name }}记录 |
  26. | 修改数据 | PUT | /{{ table.module_name }}/{{ table.business_name }}/{id} | 根据ID修改{{ table.function_name }}记录 |
  27. | 删除数据 | DELETE | /{{ table.module_name }}/{{ table.business_name }}/{ids} | 根据ID删除{{ table.function_name }}记录 |
  28. ## 权限说明
  29. 本模块涉及以下权限:
  30. 1. {{ table.module_name }}:{{ table.business_name }}:list - 查询权限
  31. 2. {{ table.module_name }}:{{ table.business_name }}:add - 新增权限
  32. 3. {{ table.module_name }}:{{ table.business_name }}:edit - 修改权限
  33. 4. {{ table.module_name }}:{{ table.business_name }}:remove - 删除权限
  34. 5. {{ table.module_name }}:{{ table.business_name }}:export - 导出权限
  35. ## 使用说明
  36. 1. 确保数据库表 `{{ table.table_name }}` 已创建并包含相应字段
  37. 2. 在系统菜单中添加对应的菜单项和权限配置
  38. 3. 启动服务后可通过API接口进行访问
  39. 4. 前端页面位于 `{{ table.module_name }}/{{ table.business_name }}/index` 路径下