SPA 项目 之 后台接口文档
SPA 项目 之 后台接口文档
- SPA 项目 之 后台接口文档
- 用户注册
- 用户登录
- 数据增加
- 数据删除
- 数据修改
- 数据查询
SPA 项目 之 后台接口文档
用户注册
用户注册接口调用：
http请求方式: POST（请使用https协议）https://localhost:8080/项目命名/vue/userAction_reg.action
| 参数 | 必须 | 含义 |
|---|---|---|
| uname | yes | 用户名 |
| pwd | yes | 密码 |
返回json数据包：
{"msg":"用户注册成功","code":1}
| 参数 | 含义 |
|---|---|
| msg | 提示消息 |
| code | 注册状态 ：1-成功；0-失败 |
用户登录
用户登录接口调用：
http请求方式: POST（请使用https协议）https://localhost:8080/项目命名/vue/userAction_login.action
| 参数 | 必须 | 含义 |
|---|---|---|
| uname | yes | 用户名 |
| pwd | yes | 密码 |
返回json数据包：
//用户名或者密码为空时{ "msg":"用户名或者密码为空","result":{"uname":"你登录的用户名","pwd":"你登录的密码"},"code":0}//用户名或者密码错误时{"msg":"用户名或者密码错误","result":{"uname":"你登录的用户名","pwd":"你登录的密码"},"code":0}//成功登录时{"msg":"登录成功","result":{"uname":"你的用户名","pwd":"你登录的密码"},"code":1}
| 参数 | 含义 |
|---|---|
| msg | 提示消息 |
| result | 返回的值 |
| code | 登录状态 ：1-成功；0-失败 |
数据增加
数据增加接口调用：
http请求方式: get（请使用https协议）https://localhost:8080/项目命名/vue/articleAction_add.action
| 参数 | 必须 | 含义 |
|---|---|---|
| title | yes | 标题 |
| body | yes | 内容 |
返回json数据包：
//增加成功{"msg":"增加成功","result":160,"code":160}//增加失败{"msg":"增加失败","result":161,"code":161}
| 参数 | 含义 |
|---|---|
| msg | 提示消息 |
| code | 注册状态 ：160-成功；161-失败 |
数据删除
数据删除接口调用：
http请求方式: get（请使用https协议）https://localhost:8080/项目命名/vue/articleAction_del.action
| 参数 | 必须 | 含义 |
|---|---|---|
| id | yes | 数据ID |
返回json数据包：
//删除成功{"msg":"删除成功","code":1}//删除失败{"msg":"删除失败","code":0}
| 参数 | 含义 |
|---|---|
| msg | 提示消息 |
| code | 注册状态 ：1-成功；0-失败 |
数据修改
数据修改接口调用：
http请求方式: get（请使用https协议）https://localhost:8080/项目命名/vue/articleAction_edit.action
| 参数 | 必须 | 含义 |
|---|---|---|
| id | yes | 数据ID |
| title | yes | 标题 |
| body | yes | 内容 |
返回json数据包：
//修改成功{"msg":"修改成功","code":1}//修改失败{"msg":"修改失败","code":0}
| 参数 | 含义 |
|---|---|
| msg | 提示消息 |
| code | 注册状态 ：1-成功；0-失败 |
数据查询
数据查询接口调用：
http请求方式: get（请使用https协议）https://localhost:8080/项目命名/vue/articleAction_list.action
| 参数 | 必须 | 含义 |
|---|---|---|
| title | no | 标题 |
| page | no | 当前页数 |
| rows | no | 每页的数据条数 |
返回json数据包：
{"result":[{"id":161,"title":"vue","body":"vue"],"pageBean":{"page":15,"rows":1,"total":0,}}
| 参数 | 含义 |
|---|---|
| id | 数据ID |
| title | 标题 |
| body | 内容 |
| pageBean | 分页对象说明 |
| page | 当前页码 |
| rows | 一页多少条 |
| total | 共查出多少条数据 |
SPA 项目 之 后台接口文档相关推荐
- springboot项目集成java接口文档生成工具knife4j
knifie knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,轻量,并 ...
- Java项目自动生成接口文档
Idea安装插件 EasyYapi 插件可基于javadoc解析API文档. 右击项目或者类即可导出接口文档: Java注释demo: 官方文档:文档 /*** 分类名称* 分类备注/描述** @mo ...
- Go 项目自动生成接口文档
CSDN 中文章不一定能及时更新,欢迎关注我的博客查看最新版本:许盛的博客 背景 如何让后端同学愉快地写接口文档,是个老大难问题. 使用 GraphQL 当接口标准,倒是省了接口文档的问题,连前端代码 ...
- Spring Boot 1.5.10项目引入knife4j接口文档
介绍 knife4j是一个在线接口文档项目,对swaggger2进行增强,页面更加美观,功能更加强大 背景 在前后端分离的趋势下,团队一直没有接口文档规范,联调接口全凭一个个接口去代码里扒,后端同事忙 ...
- 芋道 Spring Boot API 接口文档 Swagger 入门
点击上方"芋道源码",选择"设为星标" 做积极的人,而不是积极废人! 源码精品专栏 原创 | Java 2020 超神之路,很肝~ 中文详细注释的开源项目 RP ...
- 放弃丑陋的 swagger-ui，使用 knife 接口文档生成神器
文章目录 接口生成利器 knife 介绍 springboot 整合 knife pom.xml 文件增加依赖 编写Swagger2Config配置文件 注意事项 总结 knife Gitee 地址: ...
- swagger自动创建接口文档用法
现在的开发大部分都是前后端分离的模式了,后端提供接口,前端调用接口.后端提供了接口,需要对接口进行测试,之前都是使用浏览器开发者工具,或者写单元测试,再或者直接使用Postman,但是现在这些都已经o ...
- 使用knife接口文档生成器详细教程
文章目录 一.接口生成器 `knife` 介绍 二.效果图 三.SpringBoot整合knife 3.1 pom.xml的文件依赖 3.2 编写Swagger2Config配置文件 3.3 注意事项 ...
- 接口文档如何编写，接口文档快速生成工具
正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要.下面我总结下自己看到的优秀接口文档. 一.背景介绍 接口:API API(Applic ...
最新文章
- IOS学习博客不错的大部分是原创
- Ribbon负载均衡策略配置
- Process类中与内存相关的属相不能更新!
- php 二叉树判断节点的位置,PHP实现判断二叉树是否对称的方法
- 给你推荐几个 NB 的公众号
- sklearn中的正则化
- 生命、生活：同样重要
- 【ES10(2019)】Symbol 扩展 Symbol.prototype.description
- Python 进阶 —— 迭代器与生成器
- 计算机三级 信息安全技术 题纲
- 【Unity3D日常开发】Unity3D中实现向Web服务器上传图片以及下载图片功能
- python counter怎么用_Counter的基本用法
- 基于梯度下降算法求解线性回归
- python编程求三角形面积公式_python编程 输入三角形的三条边，计算三角形的面积\...
- 单点登录(4):单点登录实现（附源码）
- 微信小程序使用字体图标的方法iconfont
- 汇编语言——王爽版 总结
- 咻商跨境电商：shopee虾皮跨境电商——店铺运营篇
- 凡科网站是php类型么,建网站？那要搞清楚网站类型
- JAVA基础九 数字与字符串