API文档

目录

登陆
获取节点
新增节点
删除节点
修改节点

URL

127.0.0.1:8011/api/login

请求方法

POST

请求头

无

请求体

类型: JSON

字段:

	name	password
说明	用户名	密码
是否必须	True	True
类型	String	String
示例	cancerai	123

响应体

状态码: 200

类型: JSON

说明: 登陆成功

字段:

	message	data
说明	说明信息	token
类型	String	String
示例	"登陆成功"	"eyJhbGciOiJIUzI1NiJ9....."

状态码: 401

类型: JSON

说明: 登陆失败

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"账号或密码错误"	null

状态码: 405

类型: JSON

说明: 请求方式不支持

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"请求方式错误"	null

获取节点

URL

127.0.0.1:8011/api/get-notes

请求方法

GET

请求头

	token
说明	登陆时拿到的令牌
是否必须	True
类型	String
示例	"eyJhbGciOiJIUzI1NiJ9....."

查询参数

	token
说明	PID
是否必须	True
类型	int
示例	0

请求体

无

响应体

状态码: 200

类型: JSON

说明: 查询成功

字段:

	message	data
说明	说明信息	查询到的Note
类型	String	List
示例	"Request OK"	[{}, {}, {}]

状态码: 401

类型: JSON

说明: JWT令牌无效

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"JWT无效"	null

状态码: 401

类型: JSON

说明: JWT令牌过期

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"JWT过期"	null

状态码: 405

类型: JSON

说明: 请求方式不支持

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"请求方式错误"	null

状态码: 500

类型: JSON

说明: 没有传PID或其他问题

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"服务器内部错误"	null

新增节点

URL

127.0.0.1:8011/api/add-note

请求方法

PUT

请求头

	token
说明	登陆时拿到的令牌
是否必须	True
类型	String
示例	"eyJhbGciOiJIUzI1NiJ9....."

请求体

无

查询参数

	pid	title	content
说明	PID	note标题	note主体
是否必须	True	True	True
类型	int	String	String
示例	0	"test title"	"test content"

响应体

状态码: 200

类型: JSON

说明: 新增成功

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"成功添加节点"	null

状态码: 401

类型: JSON

说明: JWT无效或被篡改

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"JWT无效"	null

状态码: 401

类型: JSON

说明: JWT令牌过期

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"JWT过期"	null

状态码: 405

类型: JSON

说明: 请求方式不支持

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"请求方式错误"	null

状态码: 500

类型: JSON

说明: 可能请求参数不正确或服务器内部错误

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"服务器内部错误"	null

删除节点

URL

127.0.0.1:8011/api/delete-note

请求方法

DELETE

请求头

	token
说明	登陆时拿到的令牌
是否必须	True
类型	String
示例	"eyJhbGciOiJIUzI1NiJ9....."

请求体

无

查询参数

	id
说明	PID
是否必须	True
类型	int
示例	16

响应体

状态码: 200

类型: JSON

说明: 删除成功

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"成功删除节点"	null

状态码: 401

类型: JSON

说明: JWT无效或被篡改

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"JWT无效"	null

状态码: 401

类型: JSON

说明: JWT令牌过期

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"JWT过期"	null

状态码: 405

类型: JSON

说明: 请求方式不支持

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"请求方式错误"	null

状态码: 500

类型: JSON

说明: 删除不存在的id或服务器内部错误

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"服务器内部错误"	null

更新节点

URL

127.0.0.1:8011/api/update-note

请求方法

PATCH

请求头

	token
说明	登陆时拿到的令牌
是否必须	True
类型	String
示例	"eyJhbGciOiJIUzI1NiJ9....."

请求体

	id	pid	title	content
说明	要修改的note ID	修改后的note的PID	修改后的note标题	修改后的note主体
是否必须	True	True	True	True
类型	int	int	String	String
示例	16	0	"changed test"	"changed content"

查询参数

无

响应体

状态码: 200

类型: JSON

说明: 更新成功

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"成功更新节点"	null

状态码: 401

类型: JSON

说明: JWT无效或被篡改

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"JWT无效"	null

状态码: 401

类型: JSON

说明: JWT令牌过期

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"JWT过期"	null

状态码: 405

类型: JSON

说明: 请求方式不支持

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"请求方式错误"	null

状态码: 500

类型: JSON

说明: 更新的id不存在或服务器内部错误

字段:

	message	data
说明	说明信息	无
类型	String	null
示例	"服务器内部错误"	null