java电商实战api文档

java电商实战api文档

Overview

Version information

Version : 1.0

URI scheme

Host : localhost:8080
BasePath : /

Tags

• goods-controller : Goods Controller
• login-controller : Login Controller
• miaosha-controller : Miaosha Controller

Paths

获取商品ID

POST /goods/to_detail/{goodsId}

Description

返回商品详情

Parameters

Type	Name	Description	Schema
Path	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• goods-controller

获取商品ID

GET /goods/to_detail/{goodsId}

Description

返回商品详情

Parameters

Type	Name	Description	Schema
Path	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

• \*/*

Tags

• goods-controller

获取商品ID

PUT /goods/to_detail/{goodsId}

Description

返回商品详情

Parameters

Type	Name	Description	Schema
Path	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• goods-controller

获取商品ID

DELETE /goods/to_detail/{goodsId}

Description

返回商品详情

Parameters

Type	Name	Description	Schema
Path	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Produces

• \*/*

Tags

• goods-controller

获取商品ID

PATCH /goods/to_detail/{goodsId}

Description

返回商品详情

Parameters

Type	Name	Description	Schema
Path	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• goods-controller

获取商品ID

HEAD /goods/to_detail/{goodsId}

Description

返回商品详情

Parameters

Type	Name	Description	Schema
Path	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• goods-controller

获取商品ID

OPTIONS /goods/to_detail/{goodsId}

Description

返回商品详情

Parameters

Type	Name	Description	Schema
Path	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• goods-controller

秒杀

POST /goods/to_list

Description

返回商品列表

Parameters

Type	Name	Description	Schema
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• goods-controller

秒杀

GET /goods/to_list

Description

返回商品列表

Parameters

Type	Name	Description	Schema
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

• \*/*

Tags

• goods-controller

秒杀

PUT /goods/to_list

Description

返回商品列表

Parameters

Type	Name	Description	Schema
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• goods-controller

秒杀

DELETE /goods/to_list

Description

返回商品列表

Parameters

Type	Name	Description	Schema
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Produces

• \*/*

Tags

• goods-controller

秒杀

PATCH /goods/to_list

Description

返回商品列表

Parameters

Type	Name	Description	Schema
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• goods-controller

秒杀

HEAD /goods/to_list

Description

返回商品列表

Parameters

Type	Name	Description	Schema
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• goods-controller

秒杀

OPTIONS /goods/to_list

Description

返回商品列表

Parameters

Type	Name	Description	Schema
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• goods-controller

登录

POST /login/do_login

Description

返回登录成功

Parameters

Type	Name	Schema
Query	mobile optional	string
Query	password optional	string

Responses

HTTP Code	Description	Schema
200	OK	Result«boolean»
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• login-controller

登录

GET /login/do_login

Description

返回登录成功

Parameters

Type	Name	Schema
Query	mobile optional	string
Query	password optional	string

Responses

HTTP Code	Description	Schema
200	OK	Result«boolean»
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

• \*/*

Tags

• login-controller

登录

PUT /login/do_login

Description

返回登录成功

Parameters

Type	Name	Schema
Query	mobile optional	string
Query	password optional	string

Responses

HTTP Code	Description	Schema
200	OK	Result«boolean»
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• login-controller

登录

DELETE /login/do_login

Description

返回登录成功

Parameters

Type	Name	Schema
Query	mobile optional	string
Query	password optional	string

Responses

HTTP Code	Description	Schema
200	OK	Result«boolean»
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Produces

• \*/*

Tags

• login-controller

登录

PATCH /login/do_login

Description

返回登录成功

Parameters

Type	Name	Schema
Query	mobile optional	string
Query	password optional	string

Responses

HTTP Code	Description	Schema
200	OK	Result«boolean»
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• login-controller

登录

HEAD /login/do_login

Description

返回登录成功

Parameters

Type	Name	Schema
Query	mobile optional	string
Query	password optional	string

Responses

HTTP Code	Description	Schema
200	OK	Result«boolean»
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• login-controller

登录

OPTIONS /login/do_login

Description

返回登录成功

Parameters

Type	Name	Schema
Query	mobile optional	string
Query	password optional	string

Responses

HTTP Code	Description	Schema
200	OK	Result«boolean»
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• login-controller

toLogin

POST /login/to_login

Responses

HTTP Code	Description	Schema
200	OK	string
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• login-controller

toLogin

GET /login/to_login

Responses

HTTP Code	Description	Schema
200	OK	string
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

• \*/*

Tags

• login-controller

toLogin

PUT /login/to_login

Responses

HTTP Code	Description	Schema
200	OK	string
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• login-controller

toLogin

DELETE /login/to_login

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Produces

• \*/*

Tags

• login-controller

toLogin

PATCH /login/to_login

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• login-controller

toLogin

HEAD /login/to_login

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• login-controller

toLogin

OPTIONS /login/to_login

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• login-controller

商品ID

POST /miaosha/do_miaosha

Description

判断秒杀是否成功

Parameters

Type	Name	Description	Schema
Query	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• miaosha-controller

商品ID

GET /miaosha/do_miaosha

Description

判断秒杀是否成功

Parameters

Type	Name	Description	Schema
Query	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

• \*/*

Tags

• miaosha-controller

商品ID

PUT /miaosha/do_miaosha

Description

判断秒杀是否成功

Parameters

Type	Name	Description	Schema
Query	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• miaosha-controller

商品ID

DELETE /miaosha/do_miaosha

Description

判断秒杀是否成功

Parameters

Type	Name	Description	Schema
Query	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Produces

• \*/*

Tags

• miaosha-controller

商品ID

PATCH /miaosha/do_miaosha

Description

判断秒杀是否成功

Parameters

Type	Name	Description	Schema
Query	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• miaosha-controller

商品ID

HEAD /miaosha/do_miaosha

Description

判断秒杀是否成功

Parameters

Type	Name	Description	Schema
Query	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• miaosha-controller

商品ID

OPTIONS /miaosha/do_miaosha

Description

判断秒杀是否成功

Parameters

Type	Name	Description	Schema
Query	goodsId required	goodsId	integer (int64)
Query	head optional		string
Query	id optional	用户ID	integer (int64)
Query	lastLoginDate optional	最后登录时间	string (date-time)
Query	loginCount optional	登录次数	integer (int32)
Query	nickname optional	用户昵称	string
Query	password optional	用户密码	string
Query	registerDate optional	注册时间	string (date-time)
Query	salt optional		string

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Consumes

• application/json

Produces

• \*/*

Tags

• miaosha-controller

Definitions

Result«boolean»

Name	Schema
code optional	integer (int32)
data optional	boolean
msg optional	string

文档由swagger生成并导出具体使用请查看另一篇博客swagger使用
https://blog.csdn.net/weixin_43822114/article/details/106558259