店铺接口文档

通用

• 接口以/api开头
• 默认所有接口都有

Content-Type application/json
Accept application/json

• 服务端错误返回 5xx

{
	"message":"消息"
}

用户表

• id 主键
• name 用户名
• tel unique 手机号码
• avatarUrl 头像链接

注册接口

POST /api/code

{
    "tel":"13111111111"
}
这个接口会向用户下发一个手机验证码

若用户已经存在，返回 200 OK
若用户不存在，返回 201 Created
如果JSNON格式不对，返回 400 Bad Request

POST /api/register
Content-Type application/json
Accept application/json

{
	"username":"zhangsan",
    "password":"123456"
}

成功返回 201 Created
如果用户已经存在 409 Conflict
服务端错误返回 5xx

{
	"message":"消息"
}

登陆接口

POST /api/login
{
    "tel":"13111111111",
    "code":"123456"
}
成功返回 302 跳转到指定页面
用户名不对返回 403 Forbidden
用户不存在返回 404 Not Found

POST /api/login
Content-Type application/json
Accept application/json

{
	"username":"zhangsan",
	"password":"123456"
}

成功返回 302跳转到指定页面
用户名密码不对返回403 Forbidden
用户不存在返回404 Not Found

查询登陆状态

GET /api/loginStatus

成功返回200 OK
{
"login":true
"user":{
	"id":"123",
	"name":"zhangsan",
	"avatarUrl":"https://image..."
	}
}
如果没有登陆状态
{
	"login":"false"
}

商品接口

• id
• title
• description
• price

获取所有的商品

注意，price的单位是分

GET /goods
[
	{
		"id":"123",
		"title":"记事本",
		"description":"一个记事本",
		"prise":"123"
		"seller":{
			"id":"123",
			"name":"一个商家"
		}
		
	}
]

新增一个商品

POST /goods
[
	{
		"id":"123",
		"title":"记事本",
		"description":"一个记事本",
		"prise":"123"
		
	}
]
成功返回201
失败返回403

修改一个商品

PATCH /goods/123
[
	{
		"id":"123",
		"title":"记事本",
		"description":"一个记事本",
		"prise":"123"
		
	}
]
成功返回200
失败返回403

删除一个商品

DELETE /goods
[
	{
		"id":"123",
		"title":"记事本",
		"description":"一个记事本",
		"prise":"123"
		
	}
]
成功返回200
失败返回403