发表于: 2020-03-21 22:43:37

1 1235


完成接口文档的初步编写

1.留言管理

留言列表

请求地址:GET  /room/message/allMessage

请求参数:

返回参数:

字段

类型

说明

备注

是否必填

messageList

List<Message>

留言列表

返回所有留言

 

 

编辑留言

请求地址:GET  /room/message/toSelectMessage/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

Message_id

要编辑的id

返回参数:selectMessage.jsp

 

 

删除留言

请求地址:DELETE  /room/message/deleteMessage/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

Message_id

要删除的id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

Message

String

状态信息

 

 

 

取消编辑

请求地址:POST /room/message/allMessage

请求参数:无

返回参数:

字段

类型

说明

备注

是否必填

messageList

List<Message>

留言列表

返回所有留言

 

 

设为精选

请求地址:POST /room/message/allMessage

请求参数:

字段

类型

说明

备注

是否必填

Status

Number

精选状态

0普通

1精选

否,默认为0

messageList

List<Message>

留言列表

返回所有留言

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

Message

String

状态信息

 

 

 

取消精选

请求地址:POST  /room/message/allMessage

请求参数:

字段

类型

说明

备注

是否必填

Status

Number

精选状态

0普通

1精选

否,默认为0

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

Message

String

状态信息

 

 

 

回复留言

请求地址:POST room/message/replyMessage

请求参数:

字段

类型

说明

备注

是否必填

Message

String

添加留言

 

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

messageList

List<Message>

留言列表

返回所有留言

Message

String

返回数据

 

 

 

 

 

2.作品管理

作品集管理

作品集列表

请求地址:GET  /room/collection/selectCollection

请求参数:

返回参数:

字段

类型

说明

备注

是否必填

CollectinoList

List<collection>

留言列表

返回所有留言

 

 

编辑作品集

请求地址:POST  /room/collection/editCollection

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

作品集id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

 

 

删除作品集

请求地址:DELETE  /room/collection/deleteCollection/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

作品集id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

collection_name

Varchar

返回作品集

 

 

 

新增作品集

请求地址:POST /room/workshop/addworkshop

请求参数:

字段

类型

说明

备注

是否必填

id

long

Workshop_id

要增加的id

collection_name

String

作品集名称

 

 

Update_from

String

编辑人

 

 

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

collection_name

Varchar

返回作品集

 

 

 

查询单个作品集

请求地址:GET  /room/collection/selectCollection/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

Workshop_id

id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

Status

String

状态信息

 

 

 

 

作品管理

作品列表

请求地址:GET  /room/collection/selectCollection

请求参数:

返回参数:

字段

类型

说明

备注

是否必填

WorksList

List<works>

所有作品

返回所有作品的列表

 

 

编辑作品

请求地址:POST  /room/works/editWorks

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

作品集id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

 

 

删除作品

请求地址:DELETE  /room/works/deleteWorks/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

作品集id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

Works_name

Varchar

返回作品集

 

 

 

新增作品

请求地址:POST  /room/works/editWorks

请求参数:

字段

类型

说明

备注

是否必填

id

long

works_id

要增加的id

Works_name

String

作品集名称

 

 

Update_from

String

编辑人

 

 

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

Works_name

Varchar

返回作品

 

 

 

查询单个作品

请求地址:GET  /room/works/selectworks/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

Works_id

id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

Status

String

状态信息

 

 

 

 

 

3.banner管理

Banner管理

Banner列表请求地址:GET  /room/banner/selectAllBanner

请求参数:

返回参数:

字段

类型

说明

备注

是否必填

Banner

List<banner>

所有banner

返回所有banner的列表

 

 

编辑banner

请求地址:POST  /room/banner/editBanner

请求参数:

字段

类型

说明

备注

是否必填

id

long

works_id

要增加的id

Img

String

图片用链接保存

返回Url

 

Update_from

String

编辑人

 

 

Url

String

显示url地址

返回Url

 

 

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

Img

String

图片url

Url

Url

String

作品链接

Url

 

 

删除作品

请求地址:DELETE  /room/banner/deleteBanner/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

Banner_id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

 

 

新增作品

请求地址:POST  /room/banner/editBanner

请求参数:

字段

类型

说明

备注

是否必填

id

long

works_id

要增加的id

Img

String

图片用链接保存

返回Url

 

Update_from

String

编辑人

 

 

Url

String

显示url地址

返回Url

 

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

Img

String

图片url

Url

Url

String

作品链接

Url

 

 

查询单个banner

请求地址:GET  /room/banner/selectBanner/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

Works_id

id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

 

 

 

 

4.工作室管理

工作室管理

工作室列表

请求地址:GET  /room/workshop/selectWorkshop

请求参数:

返回参数:

字段

类型

说明

备注

是否必填

WorkshopList

List<workshop>

留言列表

返回所有留言

 

 

编辑工作室

请求地址:POST  /room/workshop/editWorkshop

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

作品集id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

 

 

删除工作室

请求地址:DELETE  /room/workshop/deleteWorkshop/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

作品集id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

 

 

新增工作室

请求地址:POST /room/workshop/addworkshop

请求参数:

字段

类型

说明

备注

是否必填

id

long

Workshop_id

要增加的id

Workshop_name

String

工作室名称

 

 

Update_from

String

编辑人

 

 

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

Workshop_name

Varchar

返回工作室name

 

 

 

查询单个工作室

请求地址:GET  /room/workshop/selectworkshop/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

Workshop_id

id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

Status

String

状态信息

 

 

 

 

 

5.后台管理

账户管理

账户列表

请求地址:GET  /room/manager/selectAllManager

请求参数:

返回参数:

字段

类型

说明

备注

是否必填

Manager

List<manager>

账户列表

返回所有账户

 

 

编辑账户

请求地址:POST  /room/manager/editManager

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

作品集id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

 

 

删除工作室

请求地址:DELETE  /room/manager/deleteManager/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

作品集id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

 

 

新增工作室

请求地址:POST /room/manager/editManager

请求参数:

字段

类型

说明

备注

是否必填

id

long

Workshop_id

要增加的id

Workshop_name

String

工作室名称

 

 

Update_from

String

编辑人

 

 

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

Workshop_name

Varchar

返回工作室name

 

 

 

查询单个工作室

请求地址:GET  /room/manager/selectManager/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

manager_id

id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

Status

String

状态信息

 

 

 

 

分配角色

工作室管理

工作室列表

请求地址:GET  /room/role/selectAllRole

请求参数:

返回参数:

字段

类型

说明

备注

是否必填

RoleList

List<role>

留言列表

返回所有留言

 

 

编辑工作室

请求地址:POST  /room/role/editRole

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

作品集id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

 

 

删除角色

请求地址:DELETE  /room/role/deleteRole/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

作品集id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

 

 

新增角色

请求地址:POST /room/role/editRole

请求参数:

字段

类型

说明

备注

是否必填

id

long

Role_id

要增加的id

Role_name

String

角色名称

 

 

Update_from

String

编辑人

 

 

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

Role_name

Varchar

返回角色名称

 

 

 

查询单个角色

请求地址:GET  /room/role/selectrole/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

Role_id

id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

Status

String

状态信息

 

 

 

 

修改密码

修改密码

请求地址:POST  /room/role/editPassword

请求参数:

字段

类型

说明

备注

是否必填

id

long

Role_id

id

Account

String

账户

 

Password

String

密码

 

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

Status

String

状态信息

 

 

 

 

模块管理

模块管理列表

请求地址:GET  /room/module/selectAllModule

请求参数:

返回参数:

字段

类型

说明

备注

是否必填

ModuleList

List<module>

留言列表

返回所有留言

 

 

编辑工作室

请求地址:POST  /room/module/editModule

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

作品集id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

 

 

删除角色

请求地址:DELETE  /room/module/deleteModule/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

id

作品集id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

 

 

新增角色

请求地址:POST /room/module/editModule

请求参数:

字段

类型

说明

备注

是否必填

id

long

Role_id

要增加的id

Role_name

String

角色名称

 

 

Update_from

String

编辑人

 

 

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

status

Varchar

状态信息

 

Role_name

Varchar

返回角色名称

 

 

 

查询单个角色

请求地址:GET  /room/module/selectModule/{id}

请求参数:

字段

类型

说明

备注

是否必填

id

long

Role_id

id

返回参数:

字段

类型

说明

备注

是否必填

Code

Number

状态码

 

Status

String

状态信息

 

 

 今日问题 还要修改 暂无



返回列表 返回列表
评论

    分享到