对外接口实现APIkey APIsecret demo 对外接口文档

文章目录

• 1. 管理员登录接口

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 2. 管理员修改密码

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 3. 管理员禁用用户

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 4. 管理员启用用户

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 5. 管理员查看用户情况

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 6. 管理员查看本科学校数据

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 7. 管理员搜索本科学校数据

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 8. 管理员修改本科学校数据

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 9. 管理员删除学校数据

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 10. 管理员配置推荐策略（暂不设计）
• 11.用户注册

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 12. 用户登录接口

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 13. 用户修改密码

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 14. 用户密码找回
• 15. 用户充值
• 16. 查看推荐高校

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 16. 浏览本科高校

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

• 16. 浏览专科高校

• 接口功能
• URL
• 支持格式
• HTTP请求方式
• 请求参数
• 返回字段
• 接口示例

1. 管理员登录接口

接口功能

用于管理员登录

URL

/admin/login

支持格式

JSON

HTTP请求方式

GET

请求参数

参数	必选	类型	说明
adminName	ture	string	管理员账号的用户名
passwd	true	string	管理员账号的密码

返回字段

返回字段	字段类型	说明
status	bool	返回结果状态。true：能登录；false：不能登录。
description·	string	当无法登录时，用于说明为何无法登录，如“密码错误”

接口示例

地址：/admin/login?adminName=“root”&passwd=“123”

{
    "status": true,
    "description": "登录成功",
}
{
	"status": false,
	"decription":"密码错误"，
}

2. 管理员修改密码

接口功能

用于管理员修改密码

URL

/admin/{adminName}/options

支持格式

JSON

HTTP请求方式

GET

请求参数

参数	必选	类型	说明
adminName	ture	string	管理员账号的用户名
oldPasswd	true	string	管理员账号的原密码
newPasswd	true	string	管理员账号的新密码

返回字段

返回字段	字段类型	说明
status	bool	返回结果状态。true：修改成功；false：操作失败。
description·	string	用于说明本次修改的情况

接口示例

地址：/admin/root/options?adminName=“root”&oldPasswd=“123”&newPasswd=“456”

{
    "status": true,
    "description": "成功",
}
{
	"status": false,
	"decription":"错误"，
}

3. 管理员禁用用户

接口功能

用于管理员禁用用户

URL

/admin/{adminName}/userManage

支持格式

JSON

HTTP请求方式

PATCH

请求参数

参数	必选	类型	说明
userName	ture	string	用户账号的用户名

返回字段

返回字段	字段类型	说明
status	bool	返回结果状态。true：修改成功；false：操作失败。
description·	string	用于说明本次修改的情况

接口示例

地址：/admin/root/userManage?userName=“unac”

{
    "status": true,
    "description": "成功",
}
{
	"status": false,
	"decription":"错误"，
}

4. 管理员启用用户

接口功能

用于管理员启用用户

URL

/admin/{adminName}/userManage

支持格式

JSON

HTTP请求方式

PATCH

请求参数

参数	必选	类型	说明
userName	ture	string	用户账号的用户名

返回字段

返回字段	字段类型	说明
status	bool	返回结果状态。true：修改成功；false：操作失败。
description·	string	用于说明本次修改的情况

接口示例

地址：/admin/root/userManage?userName=“unac”

{
    "status": true,
    "description": "成功",
}
{
	"status":false,
	"decription":"错误"，
}

5. 管理员查看用户情况

接口功能

用于管理员获取用户情况

URL

/admin/{adminName}/userManage

支持格式

JSON

HTTP请求方式

GET

请求参数

参数	必选	类型	说明
无	-	-	-

返回字段

返回字段	字段类型	说明
userName·	string	用户名
userVIP	bool	用户是否充值为VIP，即是否充值
usertTel	string	用户手机号
userEmail	string	用户邮箱

注：需要返回所有用户

接口示例

地址：/admin/root/userManage

{
    "userName": "unac",
    "userVIP": true,
    "userTel": "111111111",
    "userEmail": "[e-mail]"
}

6. 管理员查看本科学校数据

接口功能

用于管理员获取本科院校信息采集情况

URL

/admin/{adminName}/unSchoolsManage

支持格式

JSON

HTTP请求方式

GET

请求参数

参数	必选	类型	说明
无	-	-	-

返回字段

返回字段	字段类型	说明
schoolName·	string	学校名
is211	bool	是否是211
is985	bool	是否是985
is11	bool	是否是双一流
wuRank	int	武术连排名
wangRank	int	网大排名
schoolCode	int	院校代码

注：需要返回所有学校

接口示例

地址：/admin/root/userManage

{
    "schoolrName": "湘潭大学",
    "is985": false,
    "is211": false,
    "is11": true,
    "wuRank":10,
    "wangRank":10,
    "schoolCode":10530,
}

7. 管理员搜索本科学校数据

接口功能

用于管理员获取某一特定本科院校的情况

URL

/admin/{adminName}/unSchoolsManage

支持格式

JSON

HTTP请求方式

GET

请求参数

参数	必选	类型	说明
schoolName	true	string	本科院校名称

返回字段

返回字段	字段类型	说明
schoolName·	string	学校名
is211	bool	是否是211
is985	bool	是否是985
is11	bool	是否是双一流
wuRank	int	武术连排名
wangRank	int	网大排名
schoolCode	int	院校代码

注：需要返回特定一个学校

接口示例

地址：/admin/root/unSchoolsManage?schoolName=“湘潭大学”

{
    "schoolrName": "湘潭大学",
    "is985": false,
    "is211": false,
    "is11": true,
    "wuRank":10,
    "wangRank":10,
    "schoolCode":10530,
}

8. 管理员修改本科学校数据

接口功能

用于管理员修改某一特定本科院校的情况

URL

/admin/{adminName}/unSchoolsManage/{schoolName}

支持格式

JSON

HTTP请求方式

PUT

请求参数

参数	必选	类型	说明
schoolName	true	string	学校名称
is211	true	int	修改后是否为211
is985	true	bool	修改后是否是985
is11	true	bool	修改后是否是双一流
wuRank	true	int	修改后武术连排名
wangRank	true	int	修改后网大排名
schoolCode	true	int	修改后院校代码

返回字段

返回字段	字段类型	说明
status	bool	修改成功为true
description	string	说明本次修改的情况

接口示例

地址：/admin/root/userManage/湘潭大学

{
    status:true,
    description:"ok",
}
{
	status:false,
	description:"unknown errors"
}

9. 管理员删除学校数据

接口功能

用于管理员删除某一特定本科院校

URL

/admin/{adminName}/unSchoolsManage/{schoolName}

支持格式

JSON

HTTP请求方式

DELETE

请求参数

参数	必选	类型	说明
schoolName	true	string	学校名称

返回字段

返回字段	字段类型	说明
status	bool	修改成功为true
description	string	说明本次修改的情况

接口示例

地址：/admin/root/userManage/湘潭大学

{
    status:true,
    description:"ok",
}
{
	status:false,
	description:"unknown errors"
}

10. 管理员配置推荐策略（暂不设计）

11.用户注册

接口功能

用于用户注册帐号

URL

/user/register

支持格式

JSON

HTTP请求方式

POST

请求参数

参数	必选	类型	说明
userName	true	string	用户帐号
userPasswd	true	string	用户密码
userEmail	true	string	用户邮箱
userTel	true	string	用户电话

返回字段

返回字段	字段类型	说明
status	bool	注册成功为true
description	string	说明本次修改的情况

接口示例

地址：/user/register?userName=“unac”&userPasswd=“123456”&userEmail=“[e-mail]”&userTel=“12345678910”

{
    status:true,
    description:"ok",
}
{
	status:false,
	description:"unknown errors"
}

12. 用户登录接口

接口功能

用于用户登录

URL

/user/login

支持格式

JSON

HTTP请求方式

GET

请求参数

参数	必选	类型	说明
userName	ture	string	用户账号的用户名
passwd	true	string	用户账号的密码

返回字段

返回字段	字段类型	说明
status	bool	返回结果状态。true：能登录；false：不能登录。
description·	string	当无法登录时，用于说明为何无法登录，如“密码错误”

接口示例

地址：/user/login/userName=“unac”&passwd=“123”

{
    "status": true,
    "description": "登录成功",
}
{
	"status": false,
	"decription":"密码错误"，
}

13. 用户修改密码

接口功能

用于用户修改密码

URL

/user/{userName}/options

支持格式

JSON

HTTP请求方式

GET

请求参数

参数	必选	类型	说明
userName	ture	string	用户名
oldPasswd	true	string	账号的原密码
newPasswd	true	string	账号的新密码

返回字段

返回字段	字段类型	说明
status	bool	返回结果状态。true：修改成功；false：操作失败。
description·	string	用于说明本次修改的情况

接口示例

地址：/user/unac/options?userName=“root”&oldPasswd=“123”&newPasswd=“456”

{
    "status": true,
    "description": "成功",
}
{
	"status": false,
	"decription":"错误"，
}

14. 用户密码找回

15. 用户充值

16. 查看推荐高校

接口功能

用于用户查看推荐高校

URL

/user/{userName}/advice

支持格式

JSON

HTTP请求方式

GET

请求参数

参数	必选	类型	说明
score	ture	int	用户高考分数
province	true	string	用户高考省份

返回字段

返回字段	字段类型	说明
schoolName·	string	学校名
is211	bool	是否是211
is985	bool	是否是985
is11	bool	是否是双一流
wuRank	int	武术连排名
wangRank	int	网大排名
schoolCode	int	院校代码

接口示例

地址：/user/unac/advice?score=750&prinvince=“湖南省”

{
    "schoolrName": "湘潭大学",
    "is985": false,
    "is211": false,
    "is11": true,
    "wuRank":10,
    "wangRank":10,
    "schoolCode":10530,
}

16. 浏览本科高校

接口功能

用于用户浏览本科高校

URL

/user/{userName}/unschools

支持格式

JSON

HTTP请求方式

GET

请求参数

返回字段

返回字段	字段类型	说明
schoolName·	string	学校名
is211	bool	是否是211
is985	bool	是否是985
is11	bool	是否是双一流
wuRank	int	武术连排名
wangRank	int	网大排名
schoolCode	int	院校代码

接口示例

地址：/user/unac/unschools

{
    "schoolrName": "湘潭大学",
    "is985": false,
    "is211": false,
    "is11": true,
    "wuRank":10,
    "wangRank":10,
    "schoolCode":10530,
}

16. 浏览专科高校

接口功能

用于用户浏览专科高校

URL

/user/{userName}/proschools

支持格式

JSON

HTTP请求方式

GET

请求参数

无

返回字段

返回字段	字段类型	说明
schoolName·	string	学校名
schoolCode	int	院校代码

接口示例

地址：/user/unac/proschools

{
    "schoolrName": "大学",
    "schoolCode":10830,
}