接口设计 - Paulpaulzmx/lost_and_found GitHub Wiki

接口设计

用户登录接口

  1. 请求方式：POST
  2. 请求地址：47.106.146.182/loss
  3. 请求参数
参数名 字段类型 描述
type Int type=1时表示登录
user_name varchar(32) 用户名
user_password varchar(32) 用户密码
  1. 返回格式：JSON
  2. 返回参数
参数名 返回值说明 描述
code 0：登录成功 10001：账号不存在或密码错误 返回码
message Success：登录成功 Not_login：登录失败 返回信息
result data 返回数据
  1. 例子

用户注册接口

  1. 请求方式：POST
  2. 请求地址：47.106.146.182/loss
  3. 请求参数
参数名 字段类型 描述
type Int type=2时表示注册
str varchar(32) 包含注册时用户名密码等信息
  1. 返回格式：JSON
  2. 返回参数
参数名 返回值说明 描述
code 0：注册成功 10002：注册失败或用户名已存在 返回码
message Success：注册成功 error_login：注册失败 返回信息
result data 返回数据
  1. 例子

用户修改个人信息接口

  1. 请求方式：POST
  2. 请求地址：47.106.146.182/loss
  3. 请求参数
参数名 字段类型 描述
type Int type=3时表示修改
str varchar(32) 包含修改时用户名密码等信息
  1. 返回格式：JSON
  2. 返回参数
参数名 返回值说明 描述
code 0：修改成功 10003：修改失败 返回码
message Success：修改成功 update_user_error：修改失败 返回信息
result data 返回数据
  1. 例子

查询所有失物消息。

  1. 请求方式：POST
  2. 请求地址：47.106.146.182/loss
  3. 请求参数
参数名 字段类型 描述
type Int type=4时表示查询所有失物
  1. 返回格式：JSON
  2. 返回参数
参数名 返回值说明 描述
code 0：查询成功 返回码
message Success：查询成功 返回信息
result data 返回数据
  1. 例子

查询某一类失物消息。

  1. 请求方式：POST
  2. 请求地址：47.106.146.182/loss
  3. 请求参数
参数名 字段类型 描述
type Int type=5时表示查询某类失物
loss_type Int 包含所要查询的失物类型
  1. 返回格式：JSON
  2. 返回参数
参数名 返回值说明 描述
code 0：查询成功 返回码
message Success：查询成功 返回信息
result data 返回数据
  1. 例子

用户查询发布的失物信息

  1. 请求方式：POST
  2. 请求地址：47.106.146.182/loss
  3. 请求参数
参数名 字段类型 描述
type Int type=6时表示查询某用户发布的失物
user_id Int 用户发布的id
  1. 返回格式：JSON
  2. 返回参数
参数名 返回值说明 描述
code 0：查询成功 返回码
message Success：查询成功 返回信息
result data 返回数据

用户发布失物信息接口

  1. 请求方式：POST
  2. 请求地址：47.106.146.182/loss
  3. 请求参数
参数名 字段类型 描述
type Int type=7时表示用户发布失物
user_id Int 发布信息用户的id
  1. 返回格式：JSON
  2. 返回参数
参数名 返回值说明 描述
code 0：发布成功 返回码
message Success：发布成功 返回信息
result data 返回数据

用户删除已发布的失物信息接口

  1. 请求方式：POST
  2. 请求地址：47.106.146.182/loss
  3. 请求参数
参数名 字段类型 描述
type Int type=8时表示用户删除已发布的失物信息
loss_id Int 用户发布的失物信息id
  1. 返回格式：JSON
  2. 返回参数
参数名 返回值说明 描述
code 0：删除成功 返回码
message Success：删除成功 返回信息
result data 返回数据

用户修改已发布的失物信息接口

  1. 请求方式：POST
  2. 请求地址：47.106.146.182/loss
  3. 请求参数
参数名 字段类型 描述
type Int type=9时表示用修改已发布的失物信息
loss_id Int 用户发布的id
  1. 返回格式：JSON
  2. 返回参数
参数名 返回值说明 描述
code 0：修改成功 返回码
message Success：修改成功 返回信息
result data 返回数据