模仿微信公众平台写接口文档

下面我模仿微信公众平台。写了一些接口文档,大家有兴趣可以观赏一下。

登陆接口

http请求方式: GET
http://localhost:8080/SSH/vue/userAction_login.action
参数:

参数名说明
uname用户名
pwd密码

正确时返回JSON数据包:

在这里插入图片描述

失败时返回JSON数据包:

在这里插入图片描述
返回参数:

参数名说明
code判断是否成功,1代表成功,0代表失败
msg回调返回的提示语
result输入的参数键值对应

树形菜单加载接口

http请求方式: GET
http://localhost:8080/SSH/vue/treeNodeAction.action
无参数

正确时返回JSON数据包:

在这里插入图片描述

返回参数:

参数名说明
code判断是否成功,1代表成功,0代表失败
msg回调返回的提示语
result返回的是个array,里面放的是根目录以及他的子目录(children)

增加接口

http请求方式: POST
http://localhost:8080/SSH/vue/articleAction_add.action
参数:

参数名说明
body文章的内容
title文章标题

正确时返回JSON数据包:

在这里插入图片描述
返回参数:

参数名说明
code返回的是新增文章的ID
msg回调返回的提示语

查找接口

http请求方式: POST
http://localhost:8080/SSH/vue/articleAction_list.action
参数:

参数名说明
title查找关键字
page页数
rows一页最大数
total总个数

正确时返回JSON数据包:

在这里插入图片描述

返回参数:

参数名说明
code判断是否成功,1代表成功,0代表失败
msg回调返回的提示语
pageBean里面包含根据关键字查找到的数据的一些分页记录数。例:最大页数、一页最大数、总个数等等。。
result根据关键字查找返回的数据

删除接口

http请求方式: POST
http://localhost:8080/SSH/vue/articleAction_del.action
参数:

参数名说明
id要删除的文章ID

正确时返回JSON数据包:
在这里插入图片描述

返回参数:

参数名说明
code判断是否成功,1代表成功,0代表失败
msg回调返回的提示语

修改接口

http请求方式: POST
http://localhost:8080/SSH/vue/articleAction_edit.action
参数:

参数名说明
body文章的内容
title文章标题
id要修改的文章ID

正确时返回JSON数据包:

在这里插入图片描述

返回参数:

参数名说明
code修改文章的ID
msg回调返回的提示语
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值