java oa项目需求文档 java需求文档例子

转载

angel 2023-07-16 17:35:17

文章标签 java oa项目需求文档 javascript 服务器参数说明数据 文章分类 Java 后端开发

一、准备vo层

二、用户登录/注册(login.html)

1 用户登录验证接口

2.用户注册

3.商家登录

4.商家注册

5.超级管理员登录

三、首页（index.html）

1.查询商品分类

2.首页商品展示

3.点击分类，所有商品展示

4.商品查询

5.我的订单/个人管理

6.登录/注册

四、后台管理页面（mine.html）

1. 左侧菜单获取

2.用户管理(三个都有)

用户列表（只有商家和超级管理员有）

3.商家管理（只有商家和超级管理员有）

商品列表

商品分类

文件上传

文件删除

五、购物车（cart.html）

1.查询购物车表

2.修改购物车信息

3.查询商品表

4.查询订单表

5.删除订单

6.查询评论表

六、订单页面（order.html）

1.查询订单表

2.修改订单信息

7、商品页面(product.html)

1.查询商品

2.添加到购物车

一、准备vo层

java oa项目需求文档 java需求文档例子_服务器

二、用户登录/注册(login.html)

1 用户登录验证接口

请求路径: /login/customer
请求方式: POST
请求参数

参数名称	参数说明	备注
username	用户名	不能为空
password	密码	不能为空

返回参数

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	返回密钥token、salt(null)、customer对象信息

2.用户注册

请求路径: /login/customer/register/
请求方式: POST
请求参数
customer(json对象)

参数名称	参数说明	备注
username	用户名	不能为空
password	密码	不能为空
phone	电话	11位
email	邮箱	正则表达式

返回参数

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	Null

3.商家登录

请求路径: /login/business/
请求方式: POST
请求参数

参数名称	参数说明	备注
username	用户名	不能为空
password	密码	不能为空

返回参数

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	返回密钥token、salt(有值)、business对象信息

4.商家注册

请求路径: /login/business/register/
请求方式: POST
请求参数
customer(json对象)

参数名称	参数说明	备注
username	用户名	不能为空
password	密码	不能为空
phone	电话	11位
email	邮箱	正则表达式

返回参数

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	Null

5.超级管理员登录

请求路径: /login/
请求方式: POST
请求参数

参数名称	参数说明	备注
username	用户名	不能为空
password	密码	不能为空

返回参数

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	返回密钥token、salt(null)、role对象信息

三、首页（index.html）

1.查询商品分类

请求路径: /idnex/findcategory/{level}
请求类型: get
请求参数: level

参数名称	参数说明	备注
level	查询级别	1查询一级分类 2查询1-2 级商品分类 3查询1-2-3级商品分类

业务说明: 查询3级分类菜单数据要求三层结构嵌套
返回值: SysResult对象

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	3级商品分类信息

2.首页商品展示

请求路径: /index/findproduct/{category_id}/{number}
请求类型: get
请求参数:

参数名称	参数说明	备注
category_id	分类
number	销量	最高的3个

返回结果

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	商品对象（图片，名字，价格）

3.点击分类，所有商品展示

请求路径: /index/getIproductList?categoryId=&pageNum=1&pageSize=10
请求类型: get
请求参数: 使用pageResult对象接收

参数名称	参数说明	备注信息
categoryId	分类id	可以为null
pageNum	分页查询的页数	必须赋值不能为null
pageSize	分页查询的条数	必须赋值不能为null

返回结果

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	商品分页对象

4.商品查询

请求路径: /index/getIproductList?query=&pageNum=1&pageSize=10
请求类型: get
请求参数: 使用pageResult对象接收

参数名称	参数说明	备注信息
query	查询的东西	可以为null
pageNum	分页查询的页数	必须赋值不能为null
pageSize	分页查询的条数	必须赋值不能为null

返回结果

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	商品分页对象

5.我的订单/个人管理

判断session

（1）有没有salt,有则进入商家管理后台，没有进行下一步判断

（2）判断有没有token，有则进入消费者管理后台，没有则跳转到登录

6.登录/注册

（1）判断有没有token，有token则显示用户名和退出，没有则显示登录/注册按钮

（2）点击退出按钮删除session中的信息

四、后台管理页面（mine.html）

1. 左侧菜单获取

请求路径 /mine/getRightsList
请求类型 GET
请求参数

select * form rights r

inner join

limit l

l.id = r.id

where

l.userid = ?

响应数据 SysResult对象

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	返回权限List集合

2.用户管理(三个都有)

路由路径（/user）

修改自己的信息

（1）自己信息展示

请求路径: /user/{id}
请求类型: GET
返回值: SysResult对象

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	返回user对象

（2）根据id信息修改

请求路径: /user/updateUser
请求类型: PUT
请求参数: User对象结构

参数名称	参数说明	备注
ID	用户ID号	不能为null
phone	手机信息	不能为null
email	邮箱地址	不能为null

返回值: SysResult对象

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	null

用户列表（只有商家和超级管理员有）

（1）路由路径（/user/getcustomer）

请求路径: /user/getcustomer
请求类型: GET
请求参数: 后台使用PageResult对象接收
请求案例: http://localhost:8880/user/list?query=查询关键字&pageNum=1&pageSize=10

参数名称	参数说明	备注信息
query	用户查询的数据	可以为null
pageNum	分页查询的页数	必须赋值不能为null
pageSize	分页查询的条数	必须赋值不能为null

响应参数: SysResult对象需要携带分页对象 PageResult

参数名称	参数说明	备注信息
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	返回值PageResult对象

参数名称	参数类型	参数说明	备注信息
query	String	用户查询的数据	可以为null
pageNum	Integer	查询页数	不能为null
pageSize	Integer	查询条数	不能为null
total	Long	查询总记录数	不能为null
rows	Object	分页查询的结果	不能为null

（2）修改商家、消费者的状态

请求路径 /user/status/{id}/{status}
请求类型 PUT
请求参数: 用户ID/状态值数据

参数名称	参数类型	参数说明	备注信息
id	Integer	用户ID号	不能为null
status	boolean	参数状态信息	不能为null

返回值结果: SysResult对象

3.商家管理（只有商家和超级管理员有）

路由路径（/business）

商品列表

路由路径(/product/getproduct）

(1)查看商品列表

请求路径: /productgetProductList?bid=&pageNum=1&pageSize=10
请求类型: get
请求参数: 使用pageResult对象接收

参数名称	参数说明	备注信息
bid	商家的id	可以为null
pageNum	分页查询的页数	必须赋值不能为null
pageSize	分页查询的条数	必须赋值不能为null

返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	商品分页对象

(2)修改商品状态

请求路径: /product/updateProductStatus
请求类型: put
请求参数: 使用对象接收

参数名称	参数说明	备注
id	商品id	不能为null
status	状态信息	不能为null

返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	可以为null

(3)商品数据删除

请求路径: /product/deleteProductById
请求类型: delete
请求参数:

参数名称	参数说明	备注
id	商品id	不能为null

返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	可以为null

（4）商品新增

请求路径: http://localhost:8091/product/addproduct
请求类型: post
前端传递参数分析

{
		item: {
			images: "/2021/05/20/da0c1d4781c1499399f090da8b60f359.jpg,/2021/05/20/2ac1c34776a7465887eb019655354c3c.jpg"
			itemCatId: 560
			num: "100"
			price: 718800
			sellPoint: "【华为官方直供,至高12期免息0首付,原装正品】送华为原装无线充+运动蓝牙耳机+蓝牙音箱+三合一多功能数据线+钢化膜等！"
			title: "华为P40 Pro 5G手机【12期免息可选送豪礼】全网通智能手机"
		},
		itemDesc: {
				itemDesc: "<ul><li>品牌： <a href=https://list.jd.com/list.html".......      "
		},
		itemParam: {
			dynamicArray: [
							{paramId: 1, paramVals: "亮黑色,釉白色"}, 
							{paramId: 2, paramVals: "8GB+128GB,8GB+256GB"}
						   ],
			staticArray: [
				 	{"paramId": 3,"paramVals": "华为Mate 40 Pro"},
				    {"paramId": 4,"paramVals": "0.575kg"}.....
			 		]
		}
	}

请求参数: 使用ItemVO对象接收

参数名称	参数类型	参数说明	备注
item	Item	商品基本信息对象封装	不能为null
itemDesc	ItemDesc	商品详情信息	不能为null
itemParam	ItemParam	商品参数信息	不能为null

返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	可以为null

商品分类

路由路径：/product/getCategory

（1）获取商品分类

请求路径: /product/getCategory
请求类型: get
业务描述: 根据商品分类和参数类型,查询信息
请求参数:

参数名称	参数说明	备注
categoryId	商品分类ID号	不能为null
paramType	商品分类参数的类型	不能为null 1 为动态类型 2为静态属性

返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	商品分类参数List集合

（2）商品分类参数新增

请求路径: /product/addProductCategory
请求类型: post
业务描述: 实现商品分类参数新增操作
请求参数: 使用productCatParam对象接收

参数名称	参数说明	备注
itemCatId	商品分类ID号	不能为null
paramName	商品分类参数名称	不能为null
paramType	商品分类参数类型	不能为null

返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	可以为null

文件上传

请求路径: /file/upload
请求类型: post
请求参数:

参数名称	参数说明	备注
file	文件上传的参数名称	file中携带的是二进制信息

返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	返回ImageVO对象

文件删除

请求路径: /file/deleteFile
请求类型: delete
请求参数:

参数名称	参数说明	备注
virtualPath	文件上传的虚拟的路径	删除时需要磁盘路径一起删除

返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	可以为null

五、购物车（cart.html）

1.查询购物车表

请求路径:/cart/getcartList
请求类型: get
请求参数:
返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	order对象（订单id(oid)、数量(number)、商品id(pid)、消费者id(cutid)）

2.修改购物车信息

请求路径:/cart/updatecart/{cutid}/{num}
请求类型: post
请求参数:
返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	可以为null

3.查询商品表

请求路径:/cart/getproduct/{pid}
请求类型: get
请求参数:
返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	商品名，单价，图片

4.查询订单表

请求路径:/cart/getorder/{oid}
请求类型: get
请求参数:
返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	订单编号（code）、支付状态（status）

支付：状态

总价：单价*数量

5.删除订单

请求路径:/cart/deleteorder/{id}
请求类型: delete
请求参数:
返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	可以为null

6.查询评论表

请求路径:/cart/getcomment/{cutid}/{pid}
请求类型: get
请求参数:
返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	评论内容

六、订单页面（order.html）

1.查询订单表

请求路径:/order/getorder/{cutid}
请求类型: get
请求参数:
返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	order对象集合

2.修改订单信息

请求路径:/order/updateorder/
请求类型: post
请求参数:
返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	可以为null

7、商品页面(product.html)

商品描述

商品详情

1.查询商品

请求路径:/product/getproduct/{pid}
请求类型: get
请求参数:
返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	product对象集合

加入购物车

2.添加到购物车

请求路径:/cate/cateadd/
请求类型: get
请求参数:
返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	可以为null

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。

上一篇：java oa系统开发需求 java做oa系统怎么样

下一篇：java 函数传值传引用 java函数传参的三种方式

提问和评论都可以，用心的回复会被更多人看到评论

发布评论

相关文章