https://github.com/godcong/oauth2server
https://github.com/godcong/oauth2server
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/godcong/oauth2server
- Owner: godcong
- License: mit
- Created: 2018-02-11T07:38:09.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-05T16:30:24.000Z (over 7 years ago)
- Last Synced: 2025-01-26T08:11:26.584Z (11 months ago)
- Language: Go
- Size: 4.91 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Auth2接口文档
#环境相关:
###说明:
config.toml可以从[URL](https://github.com/godcong/oauth2server/tree/master/docker)的docker路径下下载
### 第一步修改config.toml配置文件:
[database]
name = "mysql"
username = "root"
password = "123456"
addr = "172.17.0.3"
port = "3306"
schema = "oauth2"
local = "Asia/Shanghai"
param = "?"
[redis]
\#user=root
\#password=123456
port="6379"
addr="172.17.0.2"
\#db=8
### 第二步初始化数据库:
> docker run -v [config.toml所在目录]:/home/config
godcong/oauth2server /go/src/github.com/godcong/oauth2server/cmd -c "/home/config/config.toml" init
### 第三部运行服务:
docker run -it --name o2s -P -v [config.toml所在目录]:/home/config godcong/oauth2server
### 创建客户端:
docker run -v [config.toml所在目录]:/home/config
godcong/oauth2server /go/src/github.com/godcong/oauth2server/cmd -c "/home/config/config.toml" client [redirect url]
# 服务相关:
# Step 1. 登陆授权
## 跳转到：/authorize
### 参数：
> 必填 response_type : "code" //此处填写code
必填 client_id //玛娜花园的授权客户端id
选填 state //状态码
选填 redirect_uri //回调地址，必须与服务端预留地址一致
### 返回值：
> code //用于获取token
state //返回请求的state值
### 说明：
客户端跳转到授权界面获取登陆授权。授权成功服务器跳转至客户端注册的redirect url地址，并附带参数code，state
# Step 2. 获取token
## 地址：/token
### 协议：POST
### 参数：
> 必填 client_id //玛娜花园的授权客户端id
必填 client_secret //玛娜花园预留安全码
必填 grant_type //此处填authorization_code
必填 code //step1返回的code
必填 redirect_uri //回调地址，必须与服务端预留地址一致
### 返回值：
> access_token //用户访问授权码，通过该授权码获取内容
token_type //返回bearer
refresh_token //访问授权码过期时，通过该授权码刷新访问授权码
expires_in //过期时间
# Step 3. 获取信息
## 地址：/userinfo
### 协议：GET
>
### 参数：
> 必填 access_token //用户访问授权码，通过该授权码获取内容
### 返回值：
> "sub" //用户唯一识别ID，同openid
"nickname": //用户昵称
"name": //用户名
"phone_number": //手机号
"email": //邮箱