教你怎么写后台接口文档

教你怎么写后台接口文档

2023年6月22日发(作者:)

教你怎么写后台接⼝⽂档⽂章⽬录⽤户登陆http请求⽅式: POST:8080/项⽬命名/vue/userAction_参数NamePwd是否必须是是说明⽤户名密码登录成功返回json数据:code: 1msg: "登录成功"result: {uname: "zs", pwd: "123"}登录失败返回json数据:code: 0msg: "⽤户或者密码错误"result: {uname: "zss", pwd: "123"}参数codemsgresult说明状态码 1登录成功 0登录失败提⽰消息返回的登录名和密码⽤户注册http请求⽅式: POST:8080/项⽬命名vue/userAction_参数unamepwd是否必须是是说明注册名密码注册成功返回json数据:1. code: 12. msg: "注册成功"注册失败返回json数据:1. code: 02. msg: "注册失败"参数说明code参数msg状态 1.注册成功 2.注册失败说明提⽰信息左侧树形菜单加载http请求⽅式: POST:8080/项⽬命名vue/返回的json数据{ "msg": "操作成功", "result": [ { "treeNodeId": 1, "treeNodeName": "系统管理", "treeNodeType": 1, "url": null, "position": 1, "icon": "el-icon-setting", "children": [ { "treeNodeId": 2, "treeNodeName": "⽤户管理", "treeNodeType": 2, "url": "/sys/VuexPage1", "position": 2, "icon": "el-icon-user", "children": [] }, { "treeNodeId": 3, "treeNodeName": "⾓⾊管理", "treeNodeType": 2, "url": "/sys/VuexPage2", "position": 3, "icon": "", "children": [] }, { "treeNodeId": 4, "treeNodeName": "密码修改", "treeNodeType": 2, "url": null, "position": 4, "icon": null, "children": [] } ] }, { "treeNodeId": 5, "treeNodeName": "论坛管理", "treeNodeType": 1, "url": null, "position": 5, "icon": "el-icon-reading", "children": [ { "treeNodeId": 6, "treeNodeName": "⽂章管理", "treeNodeType": 2, "url": "/sys/Articles", "position": 6, "icon": null, "children": [] } ] } ], "code": 1}参数说明msg参数resultcode消息提⽰说明菜单结果集请求状态码,1成功2失败result菜单结果集参数treeNodeIdtreeNodeNametreeNodeTypeurlpositioniconchildren说明菜单的id菜单名称菜单类型 1⽗菜单 2跳转菜单路由地址位置菜单图标⼦菜单集,如果没有则为⼀个空json数组⽂章查询http请求⽅式: POST:8080/项⽬命名vue/articleAction_参数pagerowstitle是否必须否否否说明当前页码,默认为1⼀页展⽰多少条数据,默认为10如果有就按照⽂章标题进⾏模糊查询,如果没有此参数就查询所有返回json数据包说明:{ "result":[{"id":15,"title":"solr简介","body":"solr简单了解下,相较于lucene好处在哪⾥"], "pageBean":{ "page":2, "rows":1, "total":0, }}result结果集说明参数idtitlebody说明⽂章的id标题内容pageBean 结果说明pagerows当前页码⼀页展⽰多少数据total共查出多少条数据⽂章新增http请求⽅式: POST:8080/项⽬命名vue/articleAction_参数titlebody是否必须是是说明⽂章标题⽂章内容返回json数据包说明新增成功{"msg":"新增成功","result":[],"code":1}新增失败{"msg":"新增失败","result":[],"code":0}参数msgcode说明提⽰信息状态码 1成功 0失败⽂章修改http请求⽅式: POST:8080/项⽬命名vue/articleAction_参数idtitlebody是否必须是否否说明⽂章id标题内容返回json数据包说明修改成功{"msg":"修改成功","code":1}修改失败{"msg":"修改失败","code":0}参数msgcode说明提⽰消息状态码 1成功 0失败参数说明⽂章删除http请求⽅式: POST:8080/项⽬命名vue/articleAction_参数id是否必须是说明删除的id返回json数据包说明删除成功{"msg":"删除成功","code":1}删除失败{"msg":"删除失败","code":0}参数说明msgcode提⽰消息状态码 1成功 0失败

发布者:admin,转转请注明出处:http://www.yc00.com/xiaochengxu/1687384847a6081.html

相关推荐

发表回复

评论列表(0条)

  • 暂无评论

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信