add order manage
This commit is contained in:
@@ -0,0 +1,172 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Controller\Api\V1;
|
||||
|
||||
use App\Controller\AbstractDataController;
|
||||
use App\Middleware\AuthMiddleware;
|
||||
use App\Middleware\PermissionMiddleware;
|
||||
use App\Model\Order;
|
||||
use Hyperf\HttpServer\Annotation\Controller;
|
||||
use Hyperf\HttpServer\Annotation\Middleware;
|
||||
use Hyperf\HttpServer\Annotation\RequestMapping;
|
||||
use OpenApi\Attributes as OA;
|
||||
use Psr\Http\Message\ResponseInterface;
|
||||
|
||||
/**
|
||||
* 订单管理接口（Normal Category）
|
||||
*
|
||||
* 返回所有 parsed 字段，不含 raw/hash
|
||||
*/
|
||||
#[OA\Tag(name: 'Orders', description: '订单管理')]
|
||||
#[Controller(prefix: "/api/v1/orders")]
|
||||
#[Middleware(AuthMiddleware::class)]
|
||||
#[Middleware(PermissionMiddleware::class)]
|
||||
class OrderController extends AbstractDataController
|
||||
{
|
||||
protected function getModelClass(): string
|
||||
{
|
||||
return Order::class;
|
||||
}
|
||||
|
||||
protected function getListFields(): array
|
||||
{
|
||||
return [
|
||||
'id', 'company_id', 'platform_id', 'store_id', 'order_status_id',
|
||||
'platform_order_id', 'total_amount', 'total_paid', 'total_discount',
|
||||
'created_date', 'paid_date', 'shipping_date',
|
||||
];
|
||||
}
|
||||
|
||||
protected function getDetailFields(): array
|
||||
{
|
||||
return [
|
||||
'id', 'company_id', 'platform_id', 'store_id', 'order_status_id',
|
||||
'platform_order_id', 'buyer_user_id', 'payment_method_id', 'presale',
|
||||
'total_amount', 'total_paid', 'total_discount', 'total_received',
|
||||
'freight_fee', 'tax_fee', 'discount_fee', 'commission_fee',
|
||||
'coupon_amount', 'voucher_amount', 'order_type_id',
|
||||
'created_date', 'updated_date', 'paid_date', 'shipping_date',
|
||||
'zipcode', 'city', 'province', 'country', 'ext',
|
||||
'created_at', 'updated_at',
|
||||
];
|
||||
}
|
||||
|
||||
protected function getAllowedFilters(): array
|
||||
{
|
||||
return [
|
||||
'company_id' => 'exact',
|
||||
'platform_id' => 'exact',
|
||||
'store_id' => 'exact',
|
||||
'order_status_id' => 'exact',
|
||||
'platform_order_id' => 'exact',
|
||||
'created_date_from' => 'date_from',
|
||||
'created_date_to' => 'date_to',
|
||||
'paid_date_from' => 'date_from',
|
||||
'paid_date_to' => 'date_to',
|
||||
];
|
||||
}
|
||||
|
||||
protected function getDefaultSort(): string
|
||||
{
|
||||
return 'created_date';
|
||||
}
|
||||
|
||||
/**
|
||||
* 订单列表
|
||||
*/
|
||||
#[OA\Get(
|
||||
path: '/orders',
|
||||
summary: '订单列表',
|
||||
description: '获取订单列表，支持分页、多维度筛选和时间范围筛选。返回业务字段，不含 raw/hash。',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['Orders'],
|
||||
parameters: [
|
||||
new OA\Parameter(name: 'page', in: 'query', required: false, schema: new OA\Schema(type: 'integer', default: 1)),
|
||||
new OA\Parameter(name: 'per_page', in: 'query', required: false, schema: new OA\Schema(type: 'integer', default: 15, maximum: 100)),
|
||||
new OA\Parameter(name: 'company_id', in: 'query', required: false, description: '公司 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'platform_id', in: 'query', required: false, description: '平台 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'store_id', in: 'query', required: false, description: '店铺 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'order_status_id', in: 'query', required: false, description: '订单状态 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'platform_order_id', in: 'query', required: false, description: '平台订单 ID 精确搜索', schema: new OA\Schema(type: 'string')),
|
||||
new OA\Parameter(name: 'created_date_from', in: 'query', required: false, description: '创建时间起始（含）', schema: new OA\Schema(type: 'string', format: 'date', example: '2026-01-01')),
|
||||
new OA\Parameter(name: 'created_date_to', in: 'query', required: false, description: '创建时间截止（含）', schema: new OA\Schema(type: 'string', format: 'date', example: '2026-12-31')),
|
||||
new OA\Parameter(name: 'paid_date_from', in: 'query', required: false, description: '付款时间起始（含）', schema: new OA\Schema(type: 'string', format: 'date', example: '2026-01-01')),
|
||||
new OA\Parameter(name: 'paid_date_to', in: 'query', required: false, description: '付款时间截止（含）', schema: new OA\Schema(type: 'string', format: 'date', example: '2026-12-31')),
|
||||
],
|
||||
responses: [
|
||||
new OA\Response(
|
||||
response: 200,
|
||||
description: '获取成功',
|
||||
content: new OA\JsonContent(properties: [
|
||||
new OA\Property(property: 'code', type: 'integer', example: 0),
|
||||
new OA\Property(property: 'message', type: 'string', example: '获取成功'),
|
||||
new OA\Property(property: 'data', properties: [
|
||||
new OA\Property(property: 'items', type: 'array', items: new OA\Items(ref: '#/components/schemas/Order')),
|
||||
new OA\Property(property: 'total', type: 'integer', example: 100),
|
||||
new OA\Property(property: 'page', type: 'integer', example: 1),
|
||||
new OA\Property(property: 'per_page', type: 'integer', example: 15),
|
||||
], type: 'object'),
|
||||
])
|
||||
),
|
||||
new OA\Response(response: 401, description: '未认证', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
new OA\Response(response: 403, description: '无权限', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
]
|
||||
)]
|
||||
#[RequestMapping(path: "", methods: "GET")]
|
||||
public function index(): ResponseInterface|array
|
||||
{
|
||||
return parent::index();
|
||||
}
|
||||
|
||||
/**
|
||||
* 订单详情（含关联订单子项）
|
||||
*/
|
||||
#[OA\Get(
|
||||
path: '/orders/{id}',
|
||||
summary: '订单详情',
|
||||
description: '获取订单详情，返回所有业务字段、ext 和关联的 order_items，不含 raw/hash。',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['Orders'],
|
||||
parameters: [
|
||||
new OA\Parameter(name: 'id', in: 'path', required: true, description: '订单 ID', schema: new OA\Schema(type: 'integer')),
|
||||
],
|
||||
responses: [
|
||||
new OA\Response(
|
||||
response: 200,
|
||||
description: '获取成功',
|
||||
content: new OA\JsonContent(properties: [
|
||||
new OA\Property(property: 'code', type: 'integer', example: 0),
|
||||
new OA\Property(property: 'message', type: 'string', example: '获取成功'),
|
||||
new OA\Property(property: 'data', type: 'object', allOf: [
|
||||
new OA\Schema(ref: '#/components/schemas/Order'),
|
||||
new OA\Schema(properties: [
|
||||
new OA\Property(property: 'order_items', type: 'array', items: new OA\Items(type: 'object'), description: '关联订单子项'),
|
||||
]),
|
||||
]),
|
||||
])
|
||||
),
|
||||
new OA\Response(response: 401, description: '未认证', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
new OA\Response(response: 403, description: '无权限', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
new OA\Response(response: 404, description: '数据不存在', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
]
|
||||
)]
|
||||
#[RequestMapping(path: "{id}", methods: "GET")]
|
||||
public function show(int $id): ResponseInterface|array
|
||||
{
|
||||
$result = parent::show($id);
|
||||
|
||||
// 404 响应直接返回
|
||||
if ($result instanceof ResponseInterface) {
|
||||
return $result;
|
||||
}
|
||||
|
||||
// 追加订单子项
|
||||
$order = $result['data'];
|
||||
$result['data'] = $order->toArray();
|
||||
$result['data']['order_items'] = $order->getOrderItems()->toArray();
|
||||
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,148 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Controller\Api\V1;
|
||||
|
||||
use App\Controller\AbstractDataController;
|
||||
use App\Middleware\AuthMiddleware;
|
||||
use App\Middleware\PermissionMiddleware;
|
||||
use Hyperf\HttpServer\Annotation\Controller;
|
||||
use Hyperf\HttpServer\Annotation\Middleware;
|
||||
use Hyperf\HttpServer\Annotation\RequestMapping;
|
||||
use OpenApi\Attributes as OA;
|
||||
use Psr\Http\Message\ResponseInterface;
|
||||
|
||||
/**
|
||||
* 订单管理接口（Raw Category）
|
||||
*
|
||||
* 返回关键标识 + raw + hash，供开发/调试查看原始平台数据。
|
||||
* 列表不返回 raw 字段（单条 JSONB 可达数十 KB），仅返回 hash。
|
||||
* 详情返回完整 raw。
|
||||
*/
|
||||
#[OA\Tag(name: 'Orders (Raw)', description: '订单原始数据')]
|
||||
#[Controller(prefix: "/api/v1/raw/orders")]
|
||||
#[Middleware(AuthMiddleware::class)]
|
||||
#[Middleware(PermissionMiddleware::class)]
|
||||
class RawOrderController extends OrderController
|
||||
{
|
||||
protected function getListFields(): array
|
||||
{
|
||||
return [
|
||||
'id', 'platform_order_id', 'store_id', 'company_id', 'platform_id',
|
||||
'order_status_id', 'hash', 'created_date', 'updated_at',
|
||||
];
|
||||
}
|
||||
|
||||
protected function getDetailFields(): array
|
||||
{
|
||||
return [
|
||||
'id', 'platform_order_id', 'store_id', 'company_id', 'platform_id',
|
||||
'order_status_id', 'raw', 'hash', 'ext', 'created_date',
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* 订单列表（Raw）
|
||||
*/
|
||||
#[OA\Get(
|
||||
path: '/raw/orders',
|
||||
summary: '订单列表（Raw）',
|
||||
description: '获取订单原始数据列表。返回关键标识 + hash，不含 raw 字段本身（太大）。筛选参数与 Normal 接口一致。',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['Orders (Raw)'],
|
||||
parameters: [
|
||||
new OA\Parameter(name: 'page', in: 'query', required: false, schema: new OA\Schema(type: 'integer', default: 1)),
|
||||
new OA\Parameter(name: 'per_page', in: 'query', required: false, schema: new OA\Schema(type: 'integer', default: 15, maximum: 100)),
|
||||
new OA\Parameter(name: 'company_id', in: 'query', required: false, description: '公司 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'platform_id', in: 'query', required: false, description: '平台 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'store_id', in: 'query', required: false, description: '店铺 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'order_status_id', in: 'query', required: false, description: '订单状态 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'platform_order_id', in: 'query', required: false, description: '平台订单 ID 精确搜索', schema: new OA\Schema(type: 'string')),
|
||||
new OA\Parameter(name: 'created_date_from', in: 'query', required: false, description: '创建时间起始（含）', schema: new OA\Schema(type: 'string', format: 'date')),
|
||||
new OA\Parameter(name: 'created_date_to', in: 'query', required: false, description: '创建时间截止（含）', schema: new OA\Schema(type: 'string', format: 'date')),
|
||||
new OA\Parameter(name: 'paid_date_from', in: 'query', required: false, description: '付款时间起始（含）', schema: new OA\Schema(type: 'string', format: 'date')),
|
||||
new OA\Parameter(name: 'paid_date_to', in: 'query', required: false, description: '付款时间截止（含）', schema: new OA\Schema(type: 'string', format: 'date')),
|
||||
],
|
||||
responses: [
|
||||
new OA\Response(
|
||||
response: 200,
|
||||
description: '获取成功',
|
||||
content: new OA\JsonContent(properties: [
|
||||
new OA\Property(property: 'code', type: 'integer', example: 0),
|
||||
new OA\Property(property: 'message', type: 'string', example: '获取成功'),
|
||||
new OA\Property(property: 'data', properties: [
|
||||
new OA\Property(property: 'items', type: 'array', items: new OA\Items(properties: [
|
||||
new OA\Property(property: 'id', type: 'integer'),
|
||||
new OA\Property(property: 'platform_order_id', type: 'string'),
|
||||
new OA\Property(property: 'store_id', type: 'integer'),
|
||||
new OA\Property(property: 'company_id', type: 'integer'),
|
||||
new OA\Property(property: 'platform_id', type: 'integer'),
|
||||
new OA\Property(property: 'order_status_id', type: 'integer'),
|
||||
new OA\Property(property: 'hash', type: 'string'),
|
||||
new OA\Property(property: 'created_date', type: 'string', format: 'date-time'),
|
||||
new OA\Property(property: 'updated_at', type: 'string', format: 'date-time'),
|
||||
], type: 'object')),
|
||||
new OA\Property(property: 'total', type: 'integer'),
|
||||
new OA\Property(property: 'page', type: 'integer'),
|
||||
new OA\Property(property: 'per_page', type: 'integer'),
|
||||
], type: 'object'),
|
||||
])
|
||||
),
|
||||
new OA\Response(response: 401, description: '未认证', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
new OA\Response(response: 403, description: '无权限', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
]
|
||||
)]
|
||||
#[RequestMapping(path: "", methods: "GET")]
|
||||
public function index(): ResponseInterface|array
|
||||
{
|
||||
return parent::index();
|
||||
}
|
||||
|
||||
/**
|
||||
* 订单详情（Raw）
|
||||
*
|
||||
* 跳过 OrderController 的 order_items 追加逻辑，
|
||||
* 直接调用 AbstractDataController::show()
|
||||
*/
|
||||
#[OA\Get(
|
||||
path: '/raw/orders/{id}',
|
||||
summary: '订单详情（Raw）',
|
||||
description: '获取订单原始数据详情。返回关键标识 + 完整 raw + hash + ext。',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['Orders (Raw)'],
|
||||
parameters: [
|
||||
new OA\Parameter(name: 'id', in: 'path', required: true, description: '订单 ID', schema: new OA\Schema(type: 'integer')),
|
||||
],
|
||||
responses: [
|
||||
new OA\Response(
|
||||
response: 200,
|
||||
description: '获取成功',
|
||||
content: new OA\JsonContent(properties: [
|
||||
new OA\Property(property: 'code', type: 'integer', example: 0),
|
||||
new OA\Property(property: 'message', type: 'string', example: '获取成功'),
|
||||
new OA\Property(property: 'data', properties: [
|
||||
new OA\Property(property: 'id', type: 'integer'),
|
||||
new OA\Property(property: 'platform_order_id', type: 'string'),
|
||||
new OA\Property(property: 'store_id', type: 'integer'),
|
||||
new OA\Property(property: 'company_id', type: 'integer'),
|
||||
new OA\Property(property: 'platform_id', type: 'integer'),
|
||||
new OA\Property(property: 'order_status_id', type: 'integer'),
|
||||
new OA\Property(property: 'raw', type: 'object', description: '平台原始数据'),
|
||||
new OA\Property(property: 'hash', type: 'string'),
|
||||
new OA\Property(property: 'ext', type: 'object', nullable: true),
|
||||
new OA\Property(property: 'created_date', type: 'string', format: 'date-time'),
|
||||
], type: 'object'),
|
||||
])
|
||||
),
|
||||
new OA\Response(response: 401, description: '未认证', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
new OA\Response(response: 403, description: '无权限', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
new OA\Response(response: 404, description: '数据不存在', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
]
|
||||
)]
|
||||
#[RequestMapping(path: "{id}", methods: "GET")]
|
||||
public function show(int $id): ResponseInterface|array
|
||||
{
|
||||
return AbstractDataController::show($id);
|
||||
}
|
||||
}
|
||||
@@ -5,6 +5,7 @@ declare(strict_types=1);
|
||||
namespace App\Model;
|
||||
|
||||
use App\Model\OrderItem;
|
||||
use OpenApi\Attributes as OA;
|
||||
|
||||
/**
|
||||
* @property int $id 主键
|
||||
@@ -35,12 +36,48 @@ use App\Model\OrderItem;
|
||||
* @property string $city 城市
|
||||
* @property string $province 省
|
||||
* @property string $country 国家
|
||||
* @property string $hash raw 字段的 MD5 哈希值
|
||||
* @property string $raw 远程原始数据
|
||||
* @property string $ext 扩展字段
|
||||
* @property \Carbon\Carbon $created_at
|
||||
* @property \Carbon\Carbon $updated_at
|
||||
* @property \Carbon\Carbon $created_at
|
||||
* @property \Carbon\Carbon $updated_at
|
||||
* @mixin \App_Model_Order
|
||||
*/
|
||||
#[OA\Schema(
|
||||
schema: 'Order',
|
||||
type: 'object',
|
||||
properties: [
|
||||
new OA\Property(property: 'id', type: 'integer', example: 1),
|
||||
new OA\Property(property: 'company_id', type: 'integer', example: 1),
|
||||
new OA\Property(property: 'platform_id', type: 'integer', example: 2),
|
||||
new OA\Property(property: 'store_id', type: 'integer', example: 100),
|
||||
new OA\Property(property: 'order_status_id', type: 'integer', example: 1),
|
||||
new OA\Property(property: 'platform_order_id', type: 'string', example: 'ORD-20260101-001'),
|
||||
new OA\Property(property: 'buyer_user_id', type: 'string', nullable: true, example: 'buyer_123'),
|
||||
new OA\Property(property: 'payment_method_id', type: 'integer', example: 1),
|
||||
new OA\Property(property: 'presale', type: 'boolean', example: false),
|
||||
new OA\Property(property: 'total_amount', type: 'number', format: 'decimal', example: 199.99),
|
||||
new OA\Property(property: 'total_paid', type: 'number', format: 'decimal', example: 189.99),
|
||||
new OA\Property(property: 'total_discount', type: 'number', format: 'decimal', example: 10.00),
|
||||
new OA\Property(property: 'total_received', type: 'number', format: 'decimal', example: 189.99),
|
||||
new OA\Property(property: 'freight_fee', type: 'number', format: 'decimal', example: 0.00),
|
||||
new OA\Property(property: 'tax_fee', type: 'number', format: 'decimal', example: 0.00),
|
||||
new OA\Property(property: 'discount_fee', type: 'number', format: 'decimal', example: 10.00),
|
||||
new OA\Property(property: 'commission_fee', type: 'number', format: 'decimal', example: 5.00),
|
||||
new OA\Property(property: 'coupon_amount', type: 'number', format: 'decimal', example: 0.00),
|
||||
new OA\Property(property: 'voucher_amount', type: 'number', format: 'decimal', example: 0.00),
|
||||
new OA\Property(property: 'order_type_id', type: 'integer', example: 1),
|
||||
new OA\Property(property: 'hash', type: 'string', example: 'a1b2c3d4e5f6...'),
|
||||
new OA\Property(property: 'raw', type: 'object', nullable: true, description: '平台原始数据'),
|
||||
new OA\Property(property: 'ext', type: 'object', nullable: true, description: '扩展字段'),
|
||||
new OA\Property(property: 'created_date', type: 'string', format: 'date-time'),
|
||||
new OA\Property(property: 'updated_date', type: 'string', format: 'date-time', nullable: true),
|
||||
new OA\Property(property: 'paid_date', type: 'string', format: 'date-time', nullable: true),
|
||||
new OA\Property(property: 'shipping_date', type: 'string', format: 'date-time', nullable: true),
|
||||
new OA\Property(property: 'created_at', type: 'string', format: 'date-time'),
|
||||
new OA\Property(property: 'updated_at', type: 'string', format: 'date-time'),
|
||||
]
|
||||
)]
|
||||
class Order extends Model
|
||||
{
|
||||
/**
|
||||
@@ -51,7 +88,7 @@ class Order extends Model
|
||||
/**
|
||||
* The attributes that are mass assignable.
|
||||
*/
|
||||
protected array $fillable = ['id', 'company_id', 'platform_id', 'store_id', 'order_status_id', 'platform_order_id', 'buyer_user_id', 'payment_method_id', 'presale', 'total_amount', 'total_paid', 'total_discount', 'total_received', 'freight_fee', 'tax_fee', 'discount_fee', 'commission_fee', 'coupon_amount', 'voucher_amount', 'order_type_id', 'created_date', 'updated_date', 'paid_date', 'shipping_date', 'zipcode', 'city', 'province', 'country', 'raw', 'ext', 'created_at', 'updated_at'];
|
||||
protected array $fillable = ['id', 'company_id', 'platform_id', 'store_id', 'order_status_id', 'platform_order_id', 'buyer_user_id', 'payment_method_id', 'presale', 'total_amount', 'total_paid', 'total_discount', 'total_received', 'freight_fee', 'tax_fee', 'discount_fee', 'commission_fee', 'coupon_amount', 'voucher_amount', 'order_type_id', 'created_date', 'updated_date', 'paid_date', 'shipping_date', 'zipcode', 'city', 'province', 'country', 'hash', 'raw', 'ext', 'created_at', 'updated_at'];
|
||||
|
||||
/**
|
||||
* The attributes that should be cast to native types.
|
||||
|
||||
Reference in New Issue
Block a user