# 框架

**Repository Path**: xc-team/framework

## Basic Information

- **Project Name**: 框架
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-30
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 官方源码库

<h2>目录</h2>  


* ## [注册](#register)
    * ### [普通注册](#register-account)
* ## [登录](#login)  
    * ### [账号登录](#login-account)  
    * ### [短信登录](#login-account)  
    * ### [一键登录](#login-account)  
    * ### [微信登录](#login-account)  


- - -

<h2 id="register">注册</h2>

<h2 id="login">登录</h2>

> 包含以下接口

| 名称 | url |
| ---- | ---- |
| 账号登录 | /v1/login/general |
| 短信登录 | /v1/login/sms |
| 微信登录 | /v1/login/wechat |
| QQ登录 | /v1/login/qq |
| 钉钉登录 | /v1/login/dingtalk |

> 开放以下函数

| 函数名 | 参数说明 | 返回值 |
| ---- | ---- | ---- |
| Token::read($token) | token:鉴权令牌 | array:['用户ID','过期时间'] |
| Login::getUserInfo($account) | account:账号,可以为手机号,用户名等,同登录配置 | array:[],用户信息 |

> 自定义配置如下
```php

<?php

return [
    'open_login' => true,  //开放登录
    'token_expire' => 7200, //登录过期时间
    'mobile_direct_register' => true, //开启后如果此用户不存在则直接注册并登录
    'allow_login_mode' => ['general', 'sms', 'wechat', 'qq', 'alipay', 'dingtalk'], //允许登录模式
    'allow_multiple_login' => true, //允许多端登录
    'allow_login_account_type' => ['username', 'mobile', 'email', 'nickname'],  //允许登录账号类型
    'wechat_ak' => ':keys.wechat_open_ak',  //微信开放平台账号,:keys为框架统一密钥管理文件,此写法代表密钥从keys文件中获取
    'wechat_sk' => ':keys.wechat_open_sk',  //微信开放平台密钥
    'db_depend' => [ //同步数据来源于源码库 https://gitee.com/xc-team/dashboard/projects/xc-team/resources/tree/master/db-rule
        ['user', 'id,user_type,user_status,last_login_time,last_login_ip,create_time,delete_time'], //代表用户表需要的字段
        ['user_account', 'id,uid,username,password,bind_mobile,bind_email,salt,create_time'],
        ['user_login_record', 'id,uid,type,ip,device,create_time']
    ],
    'entry' => __DIR__ . DIRECTORY_SEPARATOR . 'main.php',  //指定入口文件,不填写则直接指向响应文件
];


```

<h3 id="login-account">账号登录</h3>

描述

> 此接口为普通的账号登录接口

传入参数

> 支持多种Content-Type,以application/json方式举例
```json
{
    "account":"账号",
    "password":"密码"
}
```
| 参数名称 | 是否必填 | 说明 | 示例 |
| ---- | ---- | ---- | ---- |
| account | 是 | 账号,支持用户名、手机号、邮箱，昵称 | admin |
| password | 是 | 密码 | 123456 |

返回值
> 返回值为Json格式,以下为正确返回示例
```json
{
    "token": "4882faea-4345-94c2-6c89-f08020067eee",
    "uid": "5ABAD0C4-5DE8-DA88-C949-31EB26FA3C27",
    "nickname": "",
    "last_login_ip": "",
    "last_login_time": ""
}
```