154 lines
3.8 KiB
JavaScript
154 lines
3.8 KiB
JavaScript
/**
|
|
* @swagger
|
|
* tags:
|
|
* name: Products
|
|
* description: 商品管理API
|
|
*/
|
|
|
|
/**
|
|
* @swagger
|
|
* /products:
|
|
* get:
|
|
* summary: 获取商品列表
|
|
* tags: [Products]
|
|
* parameters:
|
|
* - in: query
|
|
* name: page
|
|
* schema:
|
|
* type: integer
|
|
* default: 1
|
|
* description: 页码
|
|
* - in: query
|
|
* name: limit
|
|
* schema:
|
|
* type: integer
|
|
* default: 10
|
|
* description: 每页数量
|
|
* - in: query
|
|
* name: search
|
|
* schema:
|
|
* type: string
|
|
* description: 搜索关键词
|
|
* - in: query
|
|
* name: category
|
|
* schema:
|
|
* type: string
|
|
* description: 商品分类
|
|
* - in: query
|
|
* name: status
|
|
* schema:
|
|
* type: string
|
|
* enum: [active, inactive]
|
|
* description: 商品状态
|
|
* responses:
|
|
* 200:
|
|
* description: 成功获取商品列表
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* properties:
|
|
* success:
|
|
* type: boolean
|
|
* data:
|
|
* type: object
|
|
* properties:
|
|
* products:
|
|
* type: array
|
|
* items:
|
|
* $ref: '#/components/schemas/Product'
|
|
* pagination:
|
|
* type: object
|
|
* properties:
|
|
* page:
|
|
* type: integer
|
|
* limit:
|
|
* type: integer
|
|
* total:
|
|
* type: integer
|
|
* pages:
|
|
* type: integer
|
|
*/
|
|
|
|
/**
|
|
* @swagger
|
|
* /products/categories:
|
|
* get:
|
|
* summary: 获取商品分类列表
|
|
* tags: [Products]
|
|
* responses:
|
|
* 200:
|
|
* description: 成功获取分类列表
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* properties:
|
|
* success:
|
|
* type: boolean
|
|
* data:
|
|
* type: array
|
|
* items:
|
|
* type: string
|
|
*/
|
|
|
|
/**
|
|
* @swagger
|
|
* /products/hot:
|
|
* get:
|
|
* summary: 获取热门商品
|
|
* tags: [Products]
|
|
* parameters:
|
|
* - in: query
|
|
* name: limit
|
|
* schema:
|
|
* type: integer
|
|
* default: 10
|
|
* description: 返回数量
|
|
* responses:
|
|
* 200:
|
|
* description: 成功获取热门商品
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* properties:
|
|
* success:
|
|
* type: boolean
|
|
* data:
|
|
* type: object
|
|
* properties:
|
|
* products:
|
|
* type: array
|
|
* items:
|
|
* $ref: '#/components/schemas/Product'
|
|
*/
|
|
|
|
/**
|
|
* @swagger
|
|
* /products/{id}:
|
|
* get:
|
|
* summary: 获取商品详情
|
|
* tags: [Products]
|
|
* parameters:
|
|
* - in: path
|
|
* name: id
|
|
* required: true
|
|
* schema:
|
|
* type: integer
|
|
* description: 商品ID
|
|
* responses:
|
|
* 200:
|
|
* description: 成功获取商品详情
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* properties:
|
|
* success:
|
|
* type: boolean
|
|
* data:
|
|
* $ref: '#/components/schemas/Product'
|
|
* 404:
|
|
* description: 商品不存在
|
|
*/ |