app接口文档.docxVIP

app接口文档 一.说明 1.本文档是项目的app接口文档，包括登录注册，获取数据，模糊查询等。 2.基本url：暂无，下列接口请求完整地址为 基本url+接口url 二.接口列表 1.认证接口(登录接口) 接口功能 进行登录认证 url /api/authentication 支持格式 表单数据 HTTP请求方式 POST 示例 j_username=adminj_password=adminremember-me=truesubmit=Login 请求参数 名称必填类型默认值描述j_username是String无用户名，用户使用此字段登录j_password是String无用户密码submit是StringLogin请求描述，Login为默认，不可更改remember-me是Stringfalse是否记住用户响应 code描述响应200登录成功设置JSESSIONID，remember-me(用户选择记住时返回此cookei)401未授权500服务器内部错误403账号密码错误请求约束 1.在登录完成后需要再次向服务器进行权限验证请求 2.remember-me为true时设置记住密码，为false时不记住 3.登录流程，1.向登录接口发送数据请求登录。 2.完成登录后再次向授权接口请求，得到本用户的CSRF-TOKEN和JSESSION 2.授权接口 接口功能 进行授权 url /api/account 支持格式 不需要 HTTP请求方式 GET 响应 code描述响应200授权成功设置cookei（JSESSIONID，CSRF-TOKEN）500服务器内部错误403请求地址错误请求约束 1.请求头需要包含 X-CSRF-TOKEN，本TOKEN为向权限接口请求得到的CSRF-TOKEN 2.如果请求的cookei中包含JSESSIONID将不会重新返回，只会返回CSRF-TOKEN 3.注册接口 请求约束 1.在注册完成后需要再次向服务器进行权限验证请求 4.注册流程，1.向注册接口发送数据请求登录。 2.完成注册后再次向授权接口请求，得到新的CSRF-TOKEN。 接口功能 进行用户注册 url /api/register 支持格式 json HTTP请求方式 POST json示例 { login:frieda, email:, password:WSZL12345, langKey:zh-cn, number} 请求参数 名称必填类型默认值描述login是String无用户名password是String无用户密码langKey是Stringzh-cn默认值不可更改number是String无用户的电话号码email是String空用户不可填写，默认值不可更改响应 code描述响应201注册成功设置JSESSIONID，remember-me(用户选择记住时返回此cookei)401未授权500服务器内部错误403缺少字段400用户名或电话号码已被使用响应的body中返回login already in use/Tel already in use，表示用户名/电话号码已被使用 4.注销接口 请求约束 1.请求头需要包含 X-CSRF-TOKEN和所有cookei 接口功能 进行用户登出 url /api/logout 支持格式 不需要 HTTP请求方式 POST 响应 code描述响应200登出成功设置JSESSIONID，remember-me(用户选择记住时返回此cookei)，CSRF-TOKEN为空401未授权500服务器内部错误 5.请求验证码接口 请求约束 1.请求头需要包含 X-CSRF-TOKEN和所有cookei 接口功能 用户注册验证码获取 url /api/account/code/{number} 支持格式 json HTTP请求方式 GET 返回示例 [688493] 返回结果是一个String数组，其中第一个是最新的验证码，为有效的验证码 请求参数 名称必填类型默认值描述number是String无用户手机号码响应 code描述响应200获取成功code数组，第一个为有效验证码401未授权500服务器内部错误6.用户信息资源接口 1.获取用户信息 请求约束 1.请求头需要包含 X-CSRF-T