我的网站

公共接口

GET 加载初始化 /api/common/init

加载初始化

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
version	string	是	版本号
lng	string	是	经度
lat	string	是	纬度

正文

无

参数

追加

version

lng

lat

响应输出

返回参数

无

无

POST 上传文件 /api/common/upload

上传文件

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
file	File	是	文件流

正文

无

参数

追加

响应输出

返回参数

无

无

示例接口

POST 测试名称 /api/demo/test/id/{id}/name/{name}

测试描述信息

权限

登录	否
鉴权	否

Headers

名称	类型	必选	描述
token	string	是	请求的Token

参数

名称	类型	必选	描述
id	integer	是	会员ID
name	string	是	用户名
data	object	是	扩展数据

正文

无

Headers

token

参数

追加

id

name

data

响应输出

返回参数

名称	类型	描述
code	integer
msg	string
data	object	扩展数据返回

{
         'code':'1',
         'msg':'返回成功'
        }

GET 无需登录的接口 /api/demo/test1

无需登录的接口

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 需要登录的接口 /api/demo/test2

需要登录的接口

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 需要登录且需要验证有相应组的权限 /api/demo/test3

需要登录且需要验证有相应组的权限

权限

登录	是
鉴权	是

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

邮箱验证码接口

POST 发送验证码 /api/ems/send

发送验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
event	string	是	事件名称

正文

无

参数

追加

email

event

响应输出

返回参数

无

无

POST 检测验证码 /api/ems/check

检测验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
event	string	是	事件名称
captcha	string	是	验证码

正文

无

参数

追加

email

event

captcha

响应输出

返回参数

无

无

首页接口

GET 首页 /api/index/index

首页

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

手机短信接口

POST 发送验证码 /api/sms/send

发送验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
event	string	是	事件名称

正文

无

参数

追加

mobile

event

响应输出

返回参数

无

无

POST 检测验证码 /api/sms/check

检测验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
event	string	是	事件名称
captcha	string	是	验证码

正文

无

参数

追加

mobile

event

captcha

响应输出

返回参数

无

无

Token接口

GET 检测Token是否过期 /api/token/check

检测Token是否过期

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 刷新Token /api/token/refresh

刷新Token

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

会员接口

GET 会员中心 /api/user/index

会员中心

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 会员登录 /api/user/login

会员登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
account	string	是	账号
password	string	是	密码

正文

无

参数

追加

account

password

响应输出

返回参数

无

无

POST 手机验证码登录 /api/user/mobilelogin

手机验证码登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

参数

追加

mobile

captcha

响应输出

返回参数

无

无

POST 注册会员 /api/user/register

注册会员

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
username	string	是	用户名
password	string	是	密码
email	string	是	邮箱
mobile	string	是	手机号
code	string	是	验证码

正文

无

参数

追加

username

password

email

mobile

code

响应输出

返回参数

无

无

POST 退出登录 /api/user/logout

退出登录

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 修改会员个人信息 /api/user/profile

修改会员个人信息

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
avatar	string	是	头像地址
username	string	是	用户名
nickname	string	是	昵称
bio	string	是	个人简介

正文

无

参数

追加

avatar

username

nickname

bio

响应输出

返回参数

无

无

POST 修改邮箱 /api/user/changeemail

修改邮箱

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
captcha	string	是	验证码

正文

无

参数

追加

email

captcha

响应输出

返回参数

无

无

POST 修改手机号 /api/user/changemobile

修改手机号

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

参数

追加

mobile

captcha

响应输出

返回参数

无

无

POST 第三方登录 /api/user/third

第三方登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
platform	string	是	平台名称
code	string	是	Code码

正文

无

参数

追加

platform

code

响应输出

返回参数

无

无

POST 重置密码 /api/user/resetpwd

重置密码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
newpassword	string	是	新密码
captcha	string	是	验证码

正文

无

参数

追加

mobile

newpassword

captcha

响应输出

返回参数

无

无

验证接口

POST 检测邮箱 /api/validate/check_email_available

检测邮箱

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
id	string	是	排除会员ID

正文

无

参数

追加

email

id

响应输出

返回参数

无

无

POST 检测用户名 /api/validate/check_username_available

检测用户名

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
username	string	是	用户名
id	string	是	排除会员ID

正文

无

参数

追加

username

id

响应输出

返回参数

无

无

POST 检测昵称 /api/validate/check_nickname_available

检测昵称

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
nickname	string	是	昵称
id	string	是	排除会员ID

正文

无

参数

追加

nickname

id

响应输出

返回参数

无

无

POST 检测手机 /api/validate/check_mobile_available

检测手机

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
id	string	是	排除会员ID

正文

无

参数

追加

mobile

id

响应输出

返回参数

无

无

POST 检测手机 /api/validate/check_mobile_exist

检测手机

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号

正文

无

参数

追加

响应输出

返回参数

无

无

POST 检测邮箱 /api/validate/check_email_exist

检测邮箱

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	邮箱

正文

无

参数

追加

响应输出

返回参数

无

无

POST 检测手机验证码 /api/validate/check_sms_correct

检测手机验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码
event	string	是	事件

正文

无

参数

追加

mobile

captcha

event

响应输出

返回参数

无

无

POST 检测邮箱验证码 /api/validate/check_ems_correct

检测邮箱验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
captcha	string	是	验证码
event	string	是	事件

正文

无

参数

追加

email

captcha

event

响应输出

返回参数

无

无