开发规范

模版引擎命名规范

tio-boot 支持多种模版引擎,以 enjoy 模版引擎为例,介绍命名规范

• enjoy-templates: enjoy 模版目录
• enjoy-sql :enjoy sql 目录
• sql-templates :SqlTemplates 目录

接口命名规范

1. 接口概述

本系统提供三个不同权限级别的页面查询接口，分别适用于不同的访问场景：

1. Private Page (/private/page): 需要用户认证，过滤 user_id。
2. Public Page (/public/page): 公开访问，不过滤 user_id，无需认证。
3. Admin Page (/page): 需要管理员认证，不过滤 user_id。

2. 接口详细说明

2.1 Private Page

• 路径: /private/page
• 方法: GET
• 描述: 查询当前认证用户的页面，返回结果过滤 user_id。
• 权限: 需要用户认证（例如，通过 JWT Token）。
• 请求头:
  • Authorization: Bearer <token>

2.2 Public Page

• 路径: /public/page
• 方法: GET
• 描述: 查询所有公开的页面，不过滤 user_id，无需认证。
• 权限: 公开访问，无需认证。

2.3 Admin Page

• 路径: /page
• 方法: GET
• 描述: 查询所有页面，不过滤 user_id，需要管理员认证。
• 权限: 需要管理员认证（例如，通过管理员 Token）。
• 请求头:
  • Authorization: Bearer <admin_token>

数据表

数据规范

创建数据表推荐包含下面的字段

  id BIGINT NOT NULL PRIMARY KEY,
  remark VARCHAR(500),
  creator VARCHAR(64) DEFAULT '',
  create_time TIMESTAMP WITHOUT TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
  updater VARCHAR(64) DEFAULT '',
  update_time TIMESTAMP WITHOUT TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
  deleted SMALLINT NOT NULL DEFAULT 0,
  tenant_id BIGINT NOT NULL DEFAULT 0