omo-msa-ams

README

简介

账户管理服务

编译

进入omo-msa-ams目录，执行go build

部署

设置环境变量

export GIN_MODE=release
export AMS_HTTP_ADDR=:80
export AMS_LOG_FILE=/var/log/ams.log
export AMS_LOG_LEVEL=INFO
export AMS_ISS=ams
export AMS_SECRET=ams-secret

• 密码加密

密码使用MD5加盐后存储，盐为用户名，可以设置环境变量为盐加后缀。

export AMS_SALT_SUFFIX=suffix

不设置变量，默认后缀为空

• SQLite

设置以下环境变量

export AMS_DATABASE_DRIVER=sqlite
export AMS_SQLITE_FILEPATH=<db文件所在路径>

• Mysql

设置以下环境变量

export AMS_DATABASE_DRIVER=mysql
export AMS_MYSQL_ADDR=127.0.0.1:3306
export AMS_MYSQL_USER=<mysyql用户>
export AMS_MYSQL_PASSWORD=<mysql密码>
export AMS_MYSQL_DATABASE=omo

设置完环境变量后启动omo-msa-ams

测试工具

• PostMan 使用PostMan导入doc/AMS.postman_collection.json

HTTP API

/ams/signup

简要描述:

• 注册账号

请求方式：

• POST

范例

curl -v -H "Content-Type:application/json" -X POST -d '{"username":"admin", "password":"admin"}' 127.0.0.1/ams/signup

参数：

参数名	必选	类型	说明
username	是	string	用户名
password	是	string	密码

返回示例

{
    "code":0, 
    "message":"",
    "data":{
        "uuid":"0bc97a7ba9645b0a556803bf9e671002"
    }
}

返回参数说明

参数名	类型	说明
uuid	string	账号UUID

备注

密码会进行MD5加盐后存储

/ams/signin

简要描述:

• 登录

请求方式：

• POST

范例

curl -v -H "Content-Type:application/json" -X POST -d '{"username":"admin", "password":"admin"}' 127.0.0.1/ams/signin

参数：

参数名	必选	类型	说明
username	是	string	用户名
password	是	string	密码

返回示例

{
    "code":200,
    "expire":"2019-05-14T15:50:13+08:00",
    "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1NTc4MjAyMTMsImlkIjoiNjg1ZDgxZWNjMDNlYzg0NzRmNGMyZWRhZmJhOGQzYzgiLCJvcmlnX2lhdCI6MTU1NzgxNjYxM30.JggbFwGDjIqo8UnvuUqOXEHnEg_Z6SJGrGXo7lg2V3s"
}

返回参数说明

参数名	类型	说明
code	int	http状态码 （200代表正常）
expire	string	token有效期
token	string	jwt token

/ams/auth/signout

简要描述:

• 登出

请求方式：

• POST

范例

curl -v -H "Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1NTc4MjAyMTMsImlkIjoiNjg1ZDgxZWNjMDNlYzg0NzRmNGMyZWRhZmJhOGQzYzgiLCJvcmlnX2lhdCI6MTU1NzgxNjYxM30.JggbFwGDjIqo8UnvuUqOXEHnEg_Z6SJGrGXo7lg2V3s" -H "Content-Type:application/json" -X POST 127.0.0.1/ams/auth/signout

参数：

参数名	必选	类型	说明

返回示例

{
    "code":0, 
    "message":"",
    "data":{
    }
}

备注

使用jwt头的ID，不需要传递额外参数

/ams/auth/current

简要描述:

• 获取账号信息

请求方式：

• GET

范例

curl -v -H "Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1NTc4MjAyMTMsImlkIjoiNjg1ZDgxZWNjMDNlYzg0NzRmNGMyZWRhZmJhOGQzYzgiLCJvcmlnX2lhdCI6MTU1NzgxNjYxM30.JggbFwGDjIqo8UnvuUqOXEHnEg_Z6SJGrGXo7lg2V3s" -H "Content-Type:application/json" -X POST 127.0.0.1/ams/auth/current

参数：

参数名	必选	类型	说明

返回示例

{
    "code":0, 
    "message":"",
    "data":{
        "profile":""
    }
}

返回参数说明

参数名	类型	说明
profile	string	账号简介

备注

使用jwt头的ID，不需要传递额外参数

/ams/auth/update

简要描述:

• 更新账户介绍

请求方式：

• POST

范例

curl -v -H "Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1NTc4MjAyMTMsImlkIjoiNjg1ZDgxZWNjMDNlYzg0NzRmNGMyZWRhZmJhOGQzYzgiLCJvcmlnX2lhdCI6MTU1NzgxNjYxM30.JggbFwGDjIqo8UnvuUqOXEHnEg_Z6SJGrGXo7lg2V3s" -H "Content-Type:application/json" -X POST -d '{"profile":"{\"nickname\":\"admini\"}"}' 127.0.0.1/ams/auth/update

参数：

参数名	必选	类型	说明
profile	是	string	简介

返回示例

{
    "code":0, 
    "message":"",
    "data":{
    }
}

/ams/auth/reset

简要描述:

• 重置密码

请求方式：

• POST

范例

curl -v -H "Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1NTc4MjAyMTMsImlkIjoiNjg1ZDgxZWNjMDNlYzg0NzRmNGMyZWRhZmJhOGQzYzgiLCJvcmlnX2lhdCI6MTU1NzgxNjYxM30.JggbFwGDjIqo8UnvuUqOXEHnEg_Z6SJGrGXo7lg2V3s" -H "Content-Type:application/json" -X POST -d '{"password":"11223344"}' 127.0.0.1/ams/auth/reset

参数：

参数名	必选	类型	说明
password	是	string	新密码

返回示例

{
    "code":0, 
    "message":"",
    "data":{
    }
}