0
点赞
收藏
分享

微信扫一扫

接口文档:第一章:简洁版接口文档


​​ApiAddressController|收货地址管理控制器​​

获取收货地址列表信息

接口说明:通过用户名获取地址列表信息

接口地址:​​/address/find​

请求方式:​​GET​

请求参数:无

添加或更新收货地址

接口说明:添加或更新收货地址,有addressID为更新,没有addressID为添加

接口地址:​​/address/save​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

address

地址

query

true

Address

删除收货地址

接口说明:根据addressID删除收货地址

接口地址:​​/address/delete​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

addressID

地址ID

query

true

Long

ApiTypeTemplateController|模板管理控制器

删除模板

接口说明:根据模板ID删除模板信息

接口地址:/typeTemplate​​/delete​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

ids

模板id数组

header

true

Long[]

根据搜索条件获取模板分页列表

接口说明:根据搜索条件获取模板分页列表

接口地址:/typeTemplate​​/search​

请求方式:POST

请求参数

参数名称

说明

in

是否必须

类型

typeTemplate

模板对象

header

false

TypeTemplate

page

页数

header

true

int

rows

条数

header

true

int

根据模板id获取模板信息

接口说明:根据模板ID查询模板信息

接口地址:/typeTemplate​​/get​​TypeTemplate

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

id

模板id

header

true

Long

添加模板

接口说明:添加模板数据

接口地址:/typeTemplate​​/save​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

typeTemplate

模板对象

header

true

TypeTemplate

更新模板

接口说明:更新模板信息

接口地址:/typeTemplate​​/update​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

typeTemplate

模板对象

header

true

TypeTemplate

​​ApiBrandController|品牌管理控制器​​

删除品牌

接口说明:根据品牌ID删除品牌信息

接口地址:/​​brand/delete​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

ids

品牌id数组

header

true

Long[]

根据搜索条件获取品牌分页列表

接口说明:根据搜索条件获取品牌分页列表

接口地址:/​​brand/search​

请求方式:POST

请求参数

参数名称

说明

in

是否必须

类型

brand

品牌对象

header

false

Brand

page

页数

header

true

int

rows

条数

header

true

int

根据品牌id获取品牌信息

接口说明:根据品牌ID查询品牌信息

接口地址:/​​brand/get​​Brand

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

id

品牌id

header

true

Long

添加品牌

接口说明:添加品牌数据

接口地址:/​​brand/save​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

brand

品牌对象

header

true

Brand

更新品牌

接口说明:更新品牌信息

接口地址:/​​brand/update​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

brand

品牌对象

header

true

Brand

​​ApiCartController|用户购物车管理控制器​​

获取购物车中的数据

接口说明:获取购物车中的数据

接口地址:​​/cart/getCart​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

sellerId

店铺ID

query

true

Long

添加购物车跳转添加成功页面

接口说明:通过skuID和数量添加购物车并跳转添加成功页面

接口地址:​​/cart/addCartToPage​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

num

数量

query

true

Integer

skuId

商品库存ID

query

true

Long

添加购物车不跳转页面

接口说明:通过skuID和数量添加购物车增加购物车商品数量

接口地址:​​/cart/addCartNum​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

num

数量

query

true

Integer

skuId

商品库存ID

query

true

Long

删除购物车

接口说明:删除选中的购物车商品,批量删除

接口地址:​​/cart/delete​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

skuId

商品库存ID

query

true

Long

​​ApiCatalogController|商品分类管理控制器​​

首页商品分类

接口说明:获取首页分类下的所有子分类

接口地址:​​/catalog/getCatalog​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

address

地址

query

true

Address

三级分类下的商品分类筛选列表

接口说明:根据三级分类id获取三级分类下的所有商品信息

接口地址:​​/catalog/getGoodsByID​

请求方式:​​GET​

请求参数:无

筛选后的商品信息

接口说明:根据筛选条件获取筛选后的商品信息

接口地址:​​/catalog/getGoodsByAttribute​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

attribute

属性对象

query

true

Attribute

删除商品分类

接口说明:根据商品分类ID删除商品分类信息

接口地址:/​​catalog/delete​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

ids

商品分类id数组

header

true

Long[]

根据搜索条件获取商品分类分页列表

接口说明:根据搜索条件获取商品分类分页列表

接口地址:/​​catalog/search​

请求方式:POST

请求参数

参数名称

说明

in

是否必须

类型

​​catalog​​

商品分类对象

header

false

​​Catalog​​

page

页数

header

true

int

rows

条数

header

true

int

根据商品分类id获取商品分类信息

接口说明:根据商品分类ID查询商品分类信息

接口地址:/​​catalog/getCatalog​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

id

商品分类id

header

true

Long

添加商品分类

接口说明:添加商品分类数据

接口地址:/​​catalog/save​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

​​catalog​​

商品分类对象

header

true

​​Catalog​​

更新商品分类

接口说明:更新商品分类

接口地址:/​​catalog/update​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

​​catalog​​

商品分类对象

header

true

​​Catalog​​

​​ApiCollectController|用户收藏管理控制器​​

添加收藏

接口说明:根据用户名添加收藏

接口地址:​​/c​​​​ollect​​​​/addCollect​

请求方式:GET

请求参数:无

获取用户收藏的商品

接口说明:根据用户名获取该用户收藏的商品

接口地址:​​/c​​​​ollect​​​​/getC​​​​ollect​​

请求方式:​​GET​

请求参数:无

删除用户收藏的商品

接口说明:根据用户商品收藏ID删除该用户收藏的商品

接口地址:​​/collect/delete​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

ID

收藏ID

query

true

Long

​​ApiCommentController|商品评论管理控制器​​

添加商品评价信息

接口说明:根据商品库存ID添加商品评价信息

接口地址:​​/comment/save​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

skuID

商品库存ID

query

true

Long

获取商品评价信息

接口说明:根据商品库存ID获取商品评价信息

接口地址:​​/comment/getComment​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

skuID

商品库存ID

query

true

Long

删除商品评价信息

接口说明:根据商品库存ID删除商品评价信息

接口地址:​​/comment/delete​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

skuID

商品库存ID

query

true

Long

​​ApiFootprintController|用户足迹管理控制器​​

添加用户历史足迹

接口说明:根据用户名添加用户足迹

接口地址:​​/footprint​​​​/addFootprint​

请求方式:GET

请求参数:无

获取用户历史足迹

接口说明:根据用户名获取该用户足迹商品

接口地址:​​/footprint​​​​/getFootprint​

请求方式:​​GET​

请求参数:无

删除用户历史足迹

接口说明:根据用户商品skuID删除该用户足迹商品

接口地址:​​/footprint/delete​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

skuID

商品库存ID

query

true

Long

​​ApiGoodsController|商品管理控制器​​

商品详情

接口说明:根据订单ID获取商品详情信息

接口地址:​​/goods/getGoods​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

orderID

订单ID

query

true

Long

ApiItemController|商品管理控制器

删除商品

接口说明:根据商品库存ID删除商品信息

接口地址:/​​item/delete​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

ids

商品id数组

header

true

Long[]

根据搜索条件获取商品分页列表

接口说明:根据搜索条件获取商品分页列表

接口地址:/​​item/search​

请求方式:POST

请求参数

参数名称

说明

in

是否必须

类型

​item​

商品对象

header

false

​Item​

page

页数

header

true

int

rows

条数

header

true

int

根据商品id获取商品信息

接口说明:根据商品库存ID查询商品信息

接口地址:/​​item/getItem​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

id

商品id

header

true

Long

添加商品

接口说明:添加商品数据

接口地址:/​​item/save​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

​item​

商品对象

header

true

​Item​

itemDesc

商品描述

header

true

String

更新商品

接口说明:更新商品信息

接口地址:/​​item/update​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

​item​

商品对象

header

true

​Item​

itemDesc

商品描述

header

true

String

​​ApiIndexController|首页控制器​​


​​ApiOrderController|订单管理控制器​​

结算后订单详情

接口说明:根据订单ID获取订单详情信息

接口地址:​​/order/getOrder​

请求方式:POST

请求参数

参数名称

说明

in

是否必须

类型

orderID

订单ID

query

true

Long

取消订单

接口说明:根据订单ID删除订单信息

接口地址:​​/order/delete​

请求方式:GET

请求参数

参数名称

说明

in

是否必须

类型

orderID

订单ID

query

true

Long

获取订单详情

接口说明:根据订单ID获取订单详情

接口地址:​​/order/getOrderById​

请求方式:GET

请求参数

参数名称

说明

in

是否必须

类型

orderID

订单ID

query

true

Long

​​ApiPayController|支付管理控制器​​

支付结算

接口说明:根据订单ID去支付

接口地址:​​/pay/pay​

请求方式:GET

请求参数

参数名称

说明

in

是否必须

类型

orderID

订单ID

query

true

Long

退款清算

接口说明:订单退款请求

接口地址:​​/pay/refund​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

orderId

订单ID

query

true

Long

​​ApiRegionController|地区管理控制器​​

​​ApiSearchController|搜索管理控制器​​

搜索关键字

接口说明:根据用户输入获取系统已有的关键字

接口地址:​​/search/helper​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

keyword

关键字

query

true

string

搜索历史记录

接口说明:获取搜索历史记录

接口地址:​​/search/history​

请求方式:​​GET​

请求参数:无

删除历史记录

接口说明:根据用户名删除搜索历史记录

接口地址:​​/search/remove​

请求方式:​​GET​

请求参数:无

​​ApiShelvesController|店铺管理控制器​​

​​ApiUploadController|上传管理控制器​​

文件上传

接口说明:上传图片信息

接口地址:/upload/uploadFile

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

​file​

要上传的文件

header

true

MultipartFile

ApiContentCategoryController|广告类型管理控制器

删除广告类型

接口说明:根据广告类型ID删除广告类型信息

接口地址:/contentCategory​​/delete​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

ids

广告类型Id数组

query

true

Long[]

根据搜索条件获取广告类型分页列表

接口说明:根据搜索条件获取广告类型分页列表

接口地址:/contentCategory​​/search​

请求方式:POST

请求参数

参数名称

说明

in

是否必须

类型

contentCategory

广告类型对象

header

false

ContentCategory

page

页数

header

true

int

rows

条数

header

true

int

根据广告类型id获取广告类型信息

接口说明:根据广告类型ID查询广告类型信息

接口地址:/contentCategory​​/get​​ContentCategory

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

id

广告类型id

header

true

Long

添加广告类型

接口说明:添加广告类型数据

接口地址:/contentCategory​​/save​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

contentCategory

广告类型对象

header

true

ContentCategory

更新广告类型

接口说明:更新广告类型信息

接口地址:/contentCategory​​/update​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

contentCategory

广告类型对象

header

true

ContentCategory

ApiContentController|广告管理控制器

删除广告

接口说明:根据广告ID删除广告信息

接口地址:/​​content/delete​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

ids

广告id数组

header

true

Long[]

根据搜索条件获取广告分页列表

接口说明:根据搜索条件获取广告分页列表

接口地址:/​​content/search​

请求方式:POST

请求参数

参数名称

说明

in

是否必须

类型

​content​

广告对象

header

false

​content​

page

页数

header

true

int

rows

条数

header

true

int

根据广告id获取广告信息

接口说明:根据广告ID查询品牌信息

接口地址:/​​content/findById​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

id

广告id

header

true

Long

添加广告

接口说明:添加广告数据

接口地址:/​​content/save​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

content

广告对象

query

true

Content

更新广告

接口说明:更新广告信息

接口地址:/​​content/update​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

​content​

广告对象

header

true

Content

ApiPersonalController|个人信息控制器

用户登录

接口说明:获取用户登录信息

接口地址:​​/user/login​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

User

用户对象

body

true

User

用户注册

接口说明:保存用户信息

接口地址:​​/user/register​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

User

用户对象

body

true

User

smsCode

验证码

body

true

Integer

用户名查询

接口说明:获取用户名

接口地址:​​/user/getUserName​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

User

用户对象

body

true

User

向已绑定的手机发送验证码

接口说明:向已绑定的手机发送验证码

接口地址:​​/user/sendSms​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

phone

手机号

body

true

Integer

向用户提交的手机发送验证码

接口说明:发送验证码

接口地址:​​/user/sendPhoneSms​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

user

用户对象

body

true

User

校验验证码是否正确

接口说明:校验验证码是否正确

接口地址:​​/user/checkSms​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

smsCode

验证码

body

true

Integer

user

用户对象

body

true

User

修改用户信息

接口说明:修改用户信息

接口地址:/​​user/update​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

user

用户对象

header

true

User

ApiSpecificationController|规格管理控制器

删除规格

接口说明:根据规格ID删除规格信息

接口地址:/specification​​/delete​

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

ids

规格id数组

header

true

Long[]

根据搜索条件获取规格分页列表

接口说明:根据搜索条件获取规格分页列表

接口地址:/specification​​/search​

请求方式:POST

请求参数

参数名称

说明

in

是否必须

类型

specification

规格对象

header

false

Specification

page

页数

header

true

int

rows

条数

header

true

int

根据规格id获取规格信息

接口说明:根据规格ID查询规格信息

接口地址:/specification​​/getS​​pecification

请求方式:​​GET​

请求参数

参数名称

说明

in

是否必须

类型

id

品牌id

header

true

Long

添加规格

接口说明:添加规格数据

接口地址:/specification​​/save​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

specification

规格对象

header

true

Specification

更新规格

接口说明:更新规格信息

接口地址:/specification​​/update​

请求方式:​​POST​

请求参数

参数名称

说明

in

是否必须

类型

specification

规格对象

header

true

Specification


举报

相关推荐

第一章.概论

第一章作业

第一章综述

第一章 引论

第一章介绍

docker 第一章

第一章 绪论

第一章 起步

0 条评论