Login 登录界面
Login Widget 用于登录界面制作。 Login DSL 文件放在 logins 目录中, 文件扩展名为 .login.yao。
约定
- 示例中约定应用根目录为
/data/app, 实际编写时需替换为应用根目录。 - 使用
<>标识自行替换的内容。 例如:icon-<图标名称>, 实际编写时应替换为:icon-foo,icon-bar...
命名
DSL 文件命名:
- 由 小写字母, 下划线 “_”, 横杠 "-" 组成,
- 必须由 小写字母 开头,
- Widget ID 为文件名称(不含扩展名), 如包含多级目录用 "." 替代 "\/"
| DSL 文件 | Widget ID |
|---|---|
| /data/app/logins/admin.login.yao | admin |
| /data/app/logins/user.login.yao | user |
当前版暂不支持多个登录界面。管理员登录界面描述文件固定为 admin.login.yao, 用户登录界面描述固定为 user.login.yao。
路由
管理员登录:
http://<IP|域名>:<YAO_PORT>/<管理后台路由前缀>/
http://<IP|域名>:<YAO_PORT>/<管理后台路由前缀>/login/admin
用户登录:
http://<IP|域名>:<YAO_PORT>/<管理后台路由前缀>/login/user
查看管理员登录示例 /data/app/logins/admin.login.yao
查看用户登录示例 /data/app/logins/user.login.yao
Login DSL
| 字段 | 类型 | 必填项 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|
| name | String | 是 | User Login | 登录界面名称, 支持多语言 | |
| layout | Object | 是 | {"entry": "/x/Table/pet"} | 页面布局定义。设置登录界面封面、登录后跳转路由地址等 | |
| action | Object | 是 | { "process": "yao.login.Admin", "args": [":payload"] } | 用户登录逻辑处理器 |
layout Object
| 字段 | 类型 | 必填项 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|
| entry | String | 是 | /x/Table/pet | 成功登录后，转向此地址。注意: 不含管理后台路由前缀 | |
| cover | String | /assets/images/login/cover.svg | 登录界面封面图片, 图片相对地址。可将图片放到应用公开目录 public ，例如: /data/app/public/images/cover.png, 填写的地址为 /images/cover.png | ||
| slogan | String | Make Your Dream With Yao App Engine | 登录界面广告语，支持多语言 | ||
| site | String | https://yaoapps.com | 登录界面封面图片下方链接地址 |
action Object
| 字段 | 类型 | 必填项 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|
| process | String | 是 | yao.login.Admin | 处理器名称 | |
| args | Array\<String> | 是 | [":paylod"] | 处理器参数表, 与 API in 编写方法一致, 接收登录 API 请求数据 |
处理器返回值数据结构约定:
查看返回值示例
自定义登录脚本示例:
查看登录脚本示例 /data/app/scirpts/user.js
API
| 请求方式 | 路由 | 鉴权 | Payload | 说明 |
|---|---|---|---|---|
GET | /api/__yao/login/:id/captcha | - | 获取用户登录图形验证码 | |
POST | /api/__yao/login/:id | - | {"email": "xiang@iqka.com","password": "A123456p+", "captcha": {"id": "XtuV3ZufGzhtJoxoGfhn", "code": "41804"}, "sid": "9YJhcWQxPt-V-G1aGsx021667052000536"} | 提交用户登录 |
处理器
| 处理器 | 参数表 | 返回值 | 说明 |
|---|---|---|---|
| yao.login.Admin | [<用户登录表单数据>] | 返回登录信息 | 查询 xiang.user 模型( xiang_user 数据表), 检查用户邮箱密码，验证用户登录并返回登录信息 |
登录逻辑编排常用处理器
| 处理器 | 参数表 | 返回值 | 说明 |
|---|---|---|---|
| yao.utils.Captcha | 图形验证码 | 返回图形验证码 查看手册 | |
| yao.utils.CaptchaValidate | ["<验证码ID>", "<验证码>"] | 图形验证码校验 查看手册 | |
| yao.utils.PasswordValidate | ["<明文密码>", "<密文密码>"] | 密码校验 查看手册 | |
| yao.utils.JwtMake | ["用户ID", "<用户数据>", "<选项>"] | 生成 JWT 查看手册 | |
| yao.utils.JwtValidate | ["<Token>"] | JWT 校验 查看手册 |
Login 登录界面
Login Widget 用于登录界面制作。 Login DSL 文件放在 logins 目录中, 文件扩展名为 .login.yao。
约定
- 示例中约定应用根目录为
/data/app, 实际编写时需替换为应用根目录。 - 使用
<>标识自行替换的内容。 例如:icon-<图标名称>, 实际编写时应替换为:icon-foo,icon-bar...
命名
DSL 文件命名:
- 由 小写字母, 下划线 “_”, 横杠 "-" 组成,
- 必须由 小写字母 开头,
- Widget ID 为文件名称(不含扩展名), 如包含多级目录用 "." 替代 "\/"
| DSL 文件 | Widget ID |
|---|---|
| /data/app/logins/admin.login.yao | admin |
| /data/app/logins/user.login.yao | user |
当前版暂不支持多个登录界面。管理员登录界面描述文件固定为 admin.login.yao, 用户登录界面描述固定为 user.login.yao。
路由
管理员登录:
http://<IP|域名>:<YAO_PORT>/<管理后台路由前缀>/
http://<IP|域名>:<YAO_PORT>/<管理后台路由前缀>/login/admin
用户登录:
http://<IP|域名>:<YAO_PORT>/<管理后台路由前缀>/login/user
查看管理员登录示例 /data/app/logins/admin.login.yao
查看用户登录示例 /data/app/logins/user.login.yao
Login DSL
| 字段 | 类型 | 必填项 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|
| name | String | 是 | User Login | 登录界面名称, 支持多语言 | |
| layout | Object | 是 | {"entry": "/x/Table/pet"} | 页面布局定义。设置登录界面封面、登录后跳转路由地址等 | |
| action | Object | 是 | { "process": "yao.login.Admin", "args": [":payload"] } | 用户登录逻辑处理器 |
layout Object
| 字段 | 类型 | 必填项 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|
| entry | String | 是 | /x/Table/pet | 成功登录后，转向此地址。注意: 不含管理后台路由前缀 | |
| cover | String | /assets/images/login/cover.svg | 登录界面封面图片, 图片相对地址。可将图片放到应用公开目录 public ，例如: /data/app/public/images/cover.png, 填写的地址为 /images/cover.png | ||
| slogan | String | Make Your Dream With Yao App Engine | 登录界面广告语，支持多语言 | ||
| site | String | https://yaoapps.com | 登录界面封面图片下方链接地址 |
action Object
| 字段 | 类型 | 必填项 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|
| process | String | 是 | yao.login.Admin | 处理器名称 | |
| args | Array\<String> | 是 | [":paylod"] | 处理器参数表, 与 API in 编写方法一致, 接收登录 API 请求数据 |
处理器返回值数据结构约定:
查看返回值示例
自定义登录脚本示例:
查看登录脚本示例 /data/app/scirpts/user.js
API
| 请求方式 | 路由 | 鉴权 | Payload | 说明 |
|---|---|---|---|---|
GET | /api/__yao/login/:id/captcha | - | 获取用户登录图形验证码 | |
POST | /api/__yao/login/:id | - | {"email": "xiang@iqka.com","password": "A123456p+", "captcha": {"id": "XtuV3ZufGzhtJoxoGfhn", "code": "41804"}, "sid": "9YJhcWQxPt-V-G1aGsx021667052000536"} | 提交用户登录 |
处理器
| 处理器 | 参数表 | 返回值 | 说明 |
|---|---|---|---|
| yao.login.Admin | [<用户登录表单数据>] | 返回登录信息 | 查询 xiang.user 模型( xiang_user 数据表), 检查用户邮箱密码，验证用户登录并返回登录信息 |
登录逻辑编排常用处理器
| 处理器 | 参数表 | 返回值 | 说明 |
|---|---|---|---|
| yao.utils.Captcha | 图形验证码 | 返回图形验证码 查看手册 | |
| yao.utils.CaptchaValidate | ["<验证码ID>", "<验证码>"] | 图形验证码校验 查看手册 | |
| yao.utils.PasswordValidate | ["<明文密码>", "<密文密码>"] | 密码校验 查看手册 | |
| yao.utils.JwtMake | ["用户ID", "<用户数据>", "<选项>"] | 生成 JWT 查看手册 | |
| yao.utils.JwtValidate | ["<Token>"] | JWT 校验 查看手册 |