add refund

2026-03-13 11:37:37 +08:00
parent 8a0166508f
commit ca2881a1e7
4 changed files with 783 additions and 0 deletions
@@ -0,0 +1,149 @@
+<?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: 'Refunds (Raw)', description: '退款原始数据')]
+#[Controller(prefix: "/api/v1/raw/refunds")]
+#[Middleware(AuthMiddleware::class)]
+#[Middleware(PermissionMiddleware::class)]
+class RawRefundController extends RefundController
+{
+    protected function getListFields(): array
+    {
+        return [
+            'id', 'platform_refund_id', 'platform_order_id',
+            'store_id', 'company_id', 'platform_id',
+            'refund_status_id', 'hash', 'created_date', 'updated_at',
+        ];
+    }
+
+    protected function getDetailFields(): array
+    {
+        return [
+            'id', 'platform_refund_id', 'platform_order_id',
+            'store_id', 'company_id', 'platform_id',
+            'refund_status_id', 'raw', 'hash', 'ext', 'created_date',
+        ];
+    }
+
+    /**
+     * 退款列表（Raw）
+     */
+    #[OA\Get(
+        path: '/raw/refunds',
+        summary: '退款列表（Raw）',
+        description: '获取退款原始数据列表。返回关键标识 + hash，不含 raw 字段本身（太大）。筛选参数与 Normal 接口一致。',
+        security: [['bearerAuth' => []]],
+        tags: ['Refunds (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: 'refund_status_id', in: 'query', required: false, description: '退款状态 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
+            new OA\Parameter(name: 'refund_type_id', in: 'query', required: false, description: '退款类型 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
+            new OA\Parameter(name: 'platform_refund_id', in: 'query', required: false, description: '平台退款 ID 精确搜索', schema: new OA\Schema(type: 'string')),
+            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')),
+        ],
+        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_refund_id', type: 'string'),
+                            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: 'refund_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）
+     */
+    #[OA\Get(
+        path: '/raw/refunds/{id}',
+        summary: '退款详情（Raw）',
+        description: '获取退款原始数据详情。返回关键标识 + 完整 raw + hash + ext。',
+        security: [['bearerAuth' => []]],
+        tags: ['Refunds (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_refund_id', type: 'string'),
+                        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: 'refund_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);
+    }
+}
@@ -0,0 +1,156 @@
+<?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\Refund;
+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: 'Refunds', description: '退款管理')]
+#[Controller(prefix: "/api/v1/refunds")]
+#[Middleware(AuthMiddleware::class)]
+#[Middleware(PermissionMiddleware::class)]
+class RefundController extends AbstractDataController
+{
+    protected function getModelClass(): string
+    {
+        return Refund::class;
+    }
+
+    protected function getListFields(): array
+    {
+        return [
+            'id', 'company_id', 'platform_id', 'store_id',
+            'platform_refund_id', 'platform_order_id',
+            'refund_status_id', 'refund_type_id',
+            'refund_amount', 'freight_refund', 'refund_total', 'currency',
+            'created_date', 'completed_date',
+        ];
+    }
+
+    protected function getDetailFields(): array
+    {
+        return [
+            'id', 'company_id', 'platform_id', 'store_id',
+            'order_id', 'platform_order_id', 'platform_refund_id',
+            'buyer_user_id', 'refund_status_id', 'refund_type_id',
+            'reason', 'refund_amount', 'freight_refund', 'refund_total', 'currency',
+            'order_created_date', 'order_paid_date',
+            'created_date', 'updated_date', 'completed_date',
+            'ext', 'created_at', 'updated_at',
+        ];
+    }
+
+    protected function getAllowedFilters(): array
+    {
+        return [
+            'company_id' => 'exact',
+            'platform_id' => 'exact',
+            'store_id' => 'exact',
+            'refund_status_id' => 'exact',
+            'refund_type_id' => 'exact',
+            'platform_refund_id' => 'exact',
+            'platform_order_id' => 'exact',
+            'created_date_from' => 'date_from',
+            'created_date_to' => 'date_to',
+        ];
+    }
+
+    protected function getDefaultSort(): string
+    {
+        return 'created_date';
+    }
+
+    /**
+     * 退款列表
+     */
+    #[OA\Get(
+        path: '/refunds',
+        summary: '退款列表',
+        description: '获取退款列表，支持分页、按退款状态/类型/时间范围筛选。返回业务字段，不含 raw/hash。',
+        security: [['bearerAuth' => []]],
+        tags: ['Refunds'],
+        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: 'refund_status_id', in: 'query', required: false, description: '退款状态 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
+            new OA\Parameter(name: 'refund_type_id', in: 'query', required: false, description: '退款类型 ID 精确筛选（1=未发货前退款 2=退货退款 3=退货后部分退款 4=无须退货退款 5=闪电退款）', schema: new OA\Schema(type: 'integer')),
+            new OA\Parameter(name: 'platform_refund_id', in: 'query', required: false, description: '平台退款 ID 精确搜索', schema: new OA\Schema(type: 'string')),
+            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')),
+        ],
+        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/Refund')),
+                        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: '/refunds/{id}',
+        summary: '退款详情',
+        description: '获取退款详情，返回所有业务字段和 ext，不含 raw/hash。',
+        security: [['bearerAuth' => []]],
+        tags: ['Refunds'],
+        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', ref: '#/components/schemas/Refund'),
+                ])
+            ),
+            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 parent::show($id);
+    }
+}
@@ -4,6 +4,7 @@ declare(strict_types=1);

 namespace App\Model;

+use OpenApi\Attributes as OA;

 /**
 * @property int $id 主键
@@ -33,6 +34,37 @@ namespace App\Model;
 * @property \Carbon\Carbon $updated_at
 * @mixin \App_Model_Refund
 */
+#[OA\Schema(
+    schema: 'Refund',
+    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_id', type: 'integer', nullable: true, example: 500),
+        new OA\Property(property: 'platform_order_id', type: 'string', example: 'ORD-20260101-001'),
+        new OA\Property(property: 'platform_refund_id', type: 'string', example: 'RF-20260115-001'),
+        new OA\Property(property: 'refund_status_id', type: 'integer', example: 1),
+        new OA\Property(property: 'refund_type_id', type: 'integer', example: 2),
+        new OA\Property(property: 'reason', type: 'string', nullable: true, example: '商品质量问题'),
+        new OA\Property(property: 'buyer_user_id', type: 'string', nullable: true, example: 'buyer_123'),
+        new OA\Property(property: 'refund_amount', type: 'number', format: 'decimal', example: 99.99),
+        new OA\Property(property: 'freight_refund', type: 'number', format: 'decimal', example: 10.00),
+        new OA\Property(property: 'refund_total', type: 'number', format: 'decimal', example: 109.99),
+        new OA\Property(property: 'currency', type: 'string', example: 'CNY'),
+        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: 'order_created_date', type: 'string', format: 'date-time', nullable: true),
+        new OA\Property(property: 'order_paid_date', type: 'string', format: 'date-time', nullable: true),
+        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: 'completed_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 Refund extends Model
 {
    /**