“小葵日记”API接口文档

“小葵日记”项目API接口文档

时间：2017/10/31

（1）用户登录【待完成】

POST：127.0.0.1/index/user/login

data

数据别称 数据名 数据类型 数据长度 备注
用户名 username varchar 64 必填
密码 password varchar 128 必填

结果1：登录成功

{
	"code" : 200,
	"data" : [
		"token" : "jdf578sr4885w4f5f745de23"
	]
	"message" : "success"
}

结果2：用户名或密码错误，登录失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

（2）获取验证码【待完成】

POST：127.0.0.1/index/sms/get_captcha

data

数据别称 数据名 数据类型 数据长度 备注
手机 tel varchar 11 必填

结果1：获取成功

{
	"code" : 200,
	"data" : NULL,
	"message" : "success"
}

结果2：获取失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

（3）用户注册【待完成】

POST：127.0.0.1/index/user/register

data

数据别称 数据名 数据类型 数据长度 备注
用户名 username varchar 64 必填
手机 tel varchar 11 必填
验证码 captcha varchar 必填
邮箱 email varchar 64 --
密码 password varchar 128 必填
确认密码 confirm_pwd varchar 128 必填

结果1：注册成功

{
	"code" : 200,
	"data" : NULL,
	"message" : "success"
}

结果2：验证码错误，注册失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "captcha error"
}

结果3：注册失败

{
	"code" : 401,
	"data" : NULL,
	"message" : "fail"
}

（4）修改密码【待完成】

POST：127.0.0.1/index/user/change_pwd

data

数据别称 数据名 数据类型 数据长度 备注
原密码 old_password varchar 128 必填
新密码 new_password varchar 128 必填

结果1：修改成功

{
	"code" : 200,
	"data" : NULL,
	"message" : "success"
}

结果2：原密码错误，修改失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "old_password error"
}

结果3：修改失败

{
	"code" : 401,
	"data" : NULL,
	"message" : "fail"
}

结果4：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（5）忘记密码【待完成】

POST：127.0.0.1/index/user/forget_pwd

data

数据别称 数据名 数据类型 数据长度 备注
手机 tel varchar 11 必填
验证码 captcha varchar 必填
新密码 new_password varchar 128 必填

结果1：修改成功

{
	"code" : 200,
	"data" : NULL,
	"message" : "success"
}

结果2：验证码错误，修改失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "captcha error"
}

结果3：修改失败

{
	"code" : 401,
	"data" : NULL,
	"message" : "fail"
}

（6）注销登录【待完成】

GET：127.0.0.1/index/user/out_login

结果1：注销成功

{
	"code" : 200,
	"data" : NULL,
	"message" : "success"
}

结果2：发生错误

{
	"code" : 400,
	"data" : NULL,
	"message" : "error"
}

（7）修改个人信息【待完成】

POST：127.0.0.1/index/user/change_user_info/user_id

data

数据别称 数据名 数据类型 数据长度 备注
昵称 nickname varchar 64 --
性别 sex int 1 0为男，1为女
简介 descript text --
生日 birthday date --
城市 u_city varchar 128 --
邮箱 email varchar 64 --

结果1：修改成功

{
	"code" : 200,
	"data" : NULL,
	"message" : "success"
}

结果2：修改失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

结果3：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（8）获取个人信息【待完成】

GET：127.0.0.1/index/user/get_user_info/user_id

结果1：获取成功

{
	"code" : 200,
	"data" : NULL,
	"message" : "success"
}

结果2：获取失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

结果3：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（9）是否存在数字密码【待完成】

GET：127.0.0.1/index/user/is_exist_pwd/user_id

结果1：成功,存在

{
	"code" : 200,
	"data" : [
		"is_exist" => TRUE,
		"pwd" => "skd45s8234e"
	],
	"message" : "success"
}

结果2：成功，不存在

{
	"code" : 200,
	"data" : [
		"is_exist" => FALSE
	],
	"message" : "success"
}

结果3：失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

结果4：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（10）设置数字密码【待完成】

POST：127.0.0.1/index/user/set_pwd/user_id

data

数据别称 数据名 数据类型 数据长度 备注
数字密码 pwd varchar 64 必填

结果1：修改成功

{
	"code" : 200,
	"data" : [
		"pwd" => "skd45s8234e"
	],
	"message" : "success"
}

结果2：修改失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

结果3：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（11）提交意见【待完成】

POST：127.0.0.1/index/advice/submit/user_id

data

数据别称 数据名 数据类型 数据长度 备注
内容 a_content text 必填
图片 a_pic file --

结果1：提交成功

{
	"code" : 200,
	"data" : NULL,
	"message" : "success"
}

结果2：提交失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

结果3：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（12）获取日记ID【待完成】

GET：127.0.0.1/index/diary/get_diary_id/user_id

结果1：获取成功

{
	"code" : 200,
	"data" : [
		"diary_id" => "sdfj6546236wdf"
	],
	"message" : "success"
}

结果2：获取失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

结果3：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（13）提交日记图片【待完成】

POST：127.0.0.1/index/diary/submit_pic/diary_id

data

数据别称 数据名 数据类型 数据长度 备注
图片 p_path1 file --
图片 p_path2 file --
图片 p_path3 file --
图片 p_pathn file --

结果1：提交成功

{
	"code" : 200,
	"data" : [
		"p_path" : [
			"p_path1" => "http://123.207.94.14/...",
			"p_path2" => "http://123.207.94.14/...",
			"p_path3" => "http://123.207.94.14/...",
			"p_pathn" => "http://123.207.94.14/..."
	],
	"message" : "success"
}

结果2：提交失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

结果3：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（14）提交日记音频【待完成】

POST：127.0.0.1/index/diary/submit_audio/diary_id

data

数据别称 数据名 数据类型 数据长度 备注
图片 a_path file --

结果1：提交成功

{
	"code" : 200,
	"data" : [
		"a_path" => "http://123.207.94.14/..."
	],
	"message" : "success"
}

结果2：提交失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

结果3：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（15）提交文本日记【待完成】

POST：127.0.0.1/index/diary/submit_html/diary_id

data

数据别称 数据名 数据类型 数据长度 备注
标题 title varchar 64 必填
内容 d_content text 必填
摘要 d_digest text 必填
地址 address varchar 128 --
天气 weather varchar 32 --
是否私密 is_private int 1 默认未0，0不设为私密，1设为私密
是否分享 is_share int 1 默认未0，0不分享，1分享

结果1：提交成功

{
	"code" : 200,
	"data" : NULL,
	"message" : "success"
}

结果2：提交失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

结果3：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（16）提交涂鸦文字图片【待完成】

POST：127.0.0.1/index/diary/submit_print/diary_id

data

数据别称 数据名 数据类型 数据长度 备注
图片 w_path1 file --
图片 w_path2 file --
图片 w_path3 file --
图片 w_pathn file --

结果1：提交成功

{
	"code" : 200,
	"data" : [
		"w_path" : [
			"w_path1" => "http://123.207.94.14/...",
			"w_path2" => "http://123.207.94.14/...",
			"w_path3" => "http://123.207.94.14/...",
			"w_pathn" => "http://123.207.94.14/..."
	],
	"message" : "success"
}

结果2：提交失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

结果3：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（17）获取一篇日记详情【待完成】

GET：127.0.0.1/index/diary/get_diary_detail/diary_id

结果1：获取文本日记成功

{
	"code" : 200,
	"data" : [
		"diary_detail" : [
			"title" => "一篇日记",
			"d_content" => "<html>今天天气很好！",
			"address" => "福州市闽侯县上街镇",
			"weather" => "晴",
			"is_private" => 1,	//是否设为私密
			"is_share" => 1,	//是否分享
			"is_print" => TRUE	//是否文本日记
		],
	"message" : "success"
}

结果2：获取失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

结果3：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（18）获取<世界发现>日记列表【待完成】

GET：127.0.0.1/index/diary/get_diary_list_by_world/count

结果1：获取文本日记成功

{
	"code" : 200,
	"data" : [
		"diary" : [
			{
				"diary_id" => "sdfjs547798w",
				"title" => "一篇日记",
				"d_digest" => "今天天气很好！",
				"address" => "福州市闽侯县上街镇",
				"weather" => "晴",
			}，
			{
				"diary_id" => "sdfjs547798w",
				"title" => "一篇日记",
				"d_digest" => "今天天气很好！",
				"address" => "福州市闽侯县上街镇",
				"weather" => "晴",
			}
		],
	"message" : "success"
}

结果2：获取失败

{
	"code" : 400,
	"data" : NULL,
	"message" : "fail"
}

结果3：请重新登陆

{
	"code" : 500,
	"data" : NULL,
	"message" : "please login"
}

（10）关注.日记.标签

Get：127.0.0.1/1【user_id】

返回结果：标签

（11）关注.日记.日记

Get：127.0.0.1/1【user_id】

返回结果：十篇日记

（12）关注. 日记by tags_id

Get：127.0.0.1/1【tags_id】

返回结果：十篇日记

（13）获取用户自定义标签列表

Get：127.0.0.1/1【user_id】

返回结果：自定义标签列表

（14）获取指定自定义标签的日记列表

Get：127.0.0.1/1【user_id】【tags_id】

返回结果：自定义标签列表

（15）收藏夹列表

Get：127.0.0.1/1【user_id】

返回结果：收藏夹列表

（16）指定收藏夹的日记列表

Get：127.0.0.1/1【collector_id】

返回结果：日记列表

（17）获取用户评论列表

Get：127.0.0.1/1【user_id】

返回结果：评论•列表

（18）评论日记

POST：127.0.0.1/1【diary_id】【user_id】【pre_id】

[data]

数据别称 数据名 数据类型 数据长度 备注

内容 com_context text 必填

返回结果

（19）获取回收站的日记列表

Get：127.0.0.1/1【user_id】

返回结果：日记列表

（26）定义新标签

Get：127.0.0.1/1【user_id】

[data]

数据别称 数据名 数据类型 数据长度 备注

标签名 t_name varchar 64 必填

返回结果：十篇日记
【推广】 免费学中医，健康全家人
原文地址：https://www.cnblogs.com/bsyt/p/7770178.html