接口demo

（具体网址暂时省略 用原地址https://api.github.com替代）

目录：

---

1. 获取用户基本信息

接口功能

获取用户基本信息 --前端向后端要数据

URL

/users

支持格式

JSON

HTTP请求方式

GET

请求参数

参数	是否必选	类型	说明
user_id	ture	int	用户的id

返回字段

返回字段	字段类型	说明
status	int	返回结果状态。0：正常；1：错误
user_id	int	用户的id
user_name	string	用户的名字
phone	int	用户的手机号
avatar_url	string	用户的头像地址
address	string	用户地址
university_id	string	用户的学校/公司
user_word	string	用户的个性签名
background_url	string	用户的背景图片
occupation	string	职业 填学生/职友
profession	int	专业
age	int	年龄
sex	int	性别 1是男生 0是女的
label	string	形容用户的词语
followers	int	追随者数量
followings	int	关注的人数量
followers_id	int	追随者的列表
followings_id	int	关注的人l的列表

接口示例

地址：https://api.github.com/users

status：1
{
user_id:0001
name:"叶星泽"
avatar_url: "https://avatars1.githubusercontent.com/u/50738107?v=4",
occupation: "学生",
age:20
sex:1
university_id："浙江大学"
profession :"1"
address："杭州"
label："可爱"
profession:"大数据182"
user_word: "练就天一第一",
followers_id: "https://api.github.com/users/mojombo/followers",
followings_id: "https://api.github.com/users/mojombo/following{/other_user}",
followers: 1,
followings: 0,
background_url: "http://pic1.win4000.com/wallpaper/0/58bf650d75bed.jpg"
}

2. 新增用户基本信息

接口功能

新增用户基本信息 ----前端向后端发起 insert 操作，后端执行逻辑

URL

/users_insert

HTTP请求方式

POST

请求参数

参数	是否必选	类型	说明
user_id	ture	int	用户名id
avatar_url	ture	string	用户的头像地址
occupation	ture	string	职业
age	ture	int	年龄
university_id	ture	int	用户的学校
profession	ture	string	专业
sex	ture	int	性别 1是男生 0是女的
user_word	false	string	用户的个性签名
label	false	string	形容用户的词语
followers	false	int	追随者数量
followings	false	int	关注的人数量
followers_id	false	int	追随者的列表
followings_id	false	int	关注的人的列表
user_word	false	string	用户的个性签名
background_url	false	string	用户的背景图片

3.修改用户基本信息

接口功能

修改用户基本信息 ---- ----前端向后端发起 updata 操作，后端执行逻辑

URL

/users_updata

HTTP请求方式

PUT

请求参数

参数	是否必选	类型	说明
user_id	ture	int	用户名
avatar_url	false	string	用户的头像地址
occupation	false	string	职业
age	false	int	年龄
sex	false	int	性别 1是男生 0是女的
university_id	false	int	用户的学校
label	false	string	形容用户的词语
user_word	false	string	用户的个性签名
profession	ture	string	专业
followers	false	int	追随者数量
followings	false	int	关注的人数量
followers_id	false	int	追随者的列表
followings_id	false	int	关注的人l的列表
user_word	false	string	用户的个性签名
background_url	false	string	用户的背景图片

4. 获取空间的数据

接口功能

获取小哈空间的数据—前端向后端要数据

URL

/room

支持格式

JSON

HTTP请求方式

GET

请求参数

参数	是否必选	类型	说明
room_id	true	int	空间的id

返回字段

返回字段	字段类型	说明
status	int	返回结果状态。0：正常；1：错误
data	string	数据源列表
room_id	int	小哈空间的id编号
title	string	标题
room_words	string	空间发布的言语
room_images_url	string	空间发布的图片
start_time	string	空间言语发布的时间
updata_time	string	空间言语再次更新的时间

接口示例

地址：https://api.github.com/rooms?room_id =yeer

{
status : 1,
data: [
{
user_id: 1,
room_words: "烤鸭真好吃，我下次还来吃这个",
room_images_url: "http://a3.att.hudong.com/68/61/300000839764127060614318218_950.jpg",
start_time: "2020.1.25.12.00",
updata_time: "2020.1.25.13.00",
},
{
id: 2,
room_words: "烤鸡真难吃，下次再也不来了",
room_images_url: "http://a3.att.hudong.com/68/61/300000839764127060614318218_950.jpg",
start_time: "2020.1.25.12.00",
updata_time: "2020.1.25.13.00",

},]
}

5. 新增空间的数据

接口功能

新增小哈空间的数据-----前端向后端发起 insert 操作，后端执行逻辑

URL

/room_insert

HTTP请求方式

POST

请求参数 状态

参数	是否必选	类型	说明
title	true	string	标题
code	true	int	状态码，1增加言语，2增加图片，12同时增加
room_words	true	string	空间发布的言语
room_images_url	true	string	空间发布的图片

6. 删除空间的数据

接口功能

删除空间的数据-----前端向后端发起 delete 操作，后端执行逻辑

URL

/room_delete

HTTP请求方式

DELETE

请求参数

参数	是否必选	类型	说明
room_id	true	int	空间的id
code	true	int	删除的代码,1删除言语，2删除图片，12同时删除

7. 编辑空间的数据

接口功能

修改空间的数据------前端向后端发起 updata 操作，后端执行逻辑

URL

/room_updata

HTTP请求方式

PUT

请求参数

参数	是否必选	类型	说明
room_id	true	int	空间的id
room_words	false	string	空间发布的言语
room_images_url	false	string	空间发布的图片

8. 获取关注人列表

获取关注人列表—前端向后端要数据

URL

/followings

支持格式

JSON

HTTP请求方式

GET

请求参数

参数	是否必选	类型	说明
user_id	true	int	用户名id

返回字段

返回字段	字段类型	说明
status	int	返回结果状态。0：正常；1：错误
data	string	数据源列表
followings_id	int	关注人的id

接口示例

地址：https://api.github.com/followers?name=xiaowang

{
status : 1,
data:
 [
{followings_id:001},
{followings_id:032},
{followings_id:035},
]
}

9. 新增关注人

新增关注人-----前端向后端发起 insert 操作，后端执行逻辑

URL

/followings_insert

HTTP请求方式

POST

请求参数

参数	是否必选	类型	说明
followings_id	ture	int	追随者的名字
followers_id	ture	int	关注人的名字

10. 取消关注人

取消关注人-----前端向后端发起delete操作

URL

/followings_delete

HTTP请求方式

DELETE

请求参数

参数	是否必选	类型	说明
followings_id	ture	int	追随者的名字
followesrs_id	ture	int	关注人的名字

11. 获取被关注列表

新增关注人-----前端向后端发起 delete 操作，后端执行逻辑

URL

/followers

HTTP请求方式

GET

请求参数

参数	是否必选	类型	说明
user_id	ture	int	用户的名字作为参数 去获取有多少人关注他

返回字段

返回字段	字段类型	说明
status	int	返回结果状态。0：正常；1：错误
data	string	数据源列表
followers_id	string	返回所有被关注的人

接口示例

地址：https://api.github.com/followering

{
status : 1,
data:
 [
{followers_id:01},
{followers_id:02},
{followers_id:03},
]
}

12. 登陆

接口功能

登陆

URL

/login

支持格式

JSON

HTTP请求方式

POST

请求参数

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

返回字段

返回字段	字段类型	说明
status	int	返回结果状态。0：正常；1：错误
message	string	信息

{
status : 1,
message：登陆成功}

13. 注册

接口功能

注册

URL

/register

支持格式

POST

请求参数

参数	是否必选	类型	说明
name	ture	string	用户名
password	ture	string	密码
phone	ture	int	手机号

返回字段

返回字段	字段类型	说明
status	int	返回结果状态。0：正常；1：错误
message	string	信息

{
status : 1,
message：注册成功
phone:15857452451}

14. 获得聊天数据

接口功能

获得别人给某用户的发的聊天数据

URL

/conversation

支持格式

JSON

HTTP请求方式

GET

请求参数

参数	是否必选	类型	说明
user_id	ture	int	用户名

返回字段

返回字段	字段类型	说明
status	int	返回结果状态。0：正常；1：错误
data	string	包裹数据
id	int	消息的id
message	string	别人给当前用户的私信

{
status : 1,
data[
id:1
message:"我明天来上班",
id:2
message:"我明天请假"
]}

15. 发送聊天数据

接口功能

发送聊天数据 放入后端的数据库

URL

/conversation_post

支持格式

JSON

HTTP请求方式

POST

请求参数

参数	是否必选	类型	说明
user_id	ture	int	用户名
message	ture	string	用户名