azumag / graphql-upload
支持 GraphQL 文件上传的中间件
3.0.0
2018-06-13 07:54 UTC
This package is not auto-updated.
Last update: 2024-09-21 16:01:02 UTC
README
这是一个支持 GraphQL 文件上传的中间件。它实现了 multipart request specification,用于 webonyx/graphql-php。
快速开始
通过 composer 安装库
composer require ecodev/graphql-upload
配置为中间件
在 Zend Expressive 中,通常在 config/routes.php
文件中配置,例如
use Application\Action\GraphQLAction; use Zend\Expressive\Helper\BodyParams\BodyParamsMiddleware; use GraphQL\Upload\UploadMiddleware; $app->post('/graphql', [ BodyParamsMiddleware::class, UploadMiddleware::class, // This is the magic GraphQLAction::class, ], 'graphql');
直接使用
如果你不使用中间件,可以直接调用,如下所示
<?php use GraphQL\Server\StandardServer; use GraphQL\Upload\UploadMiddleware; use Zend\Diactoros\ServerRequestFactory; // Create request (or get it from a framework) $request = ServerRequestFactory::fromGlobals(); $request = $request->withParsedBody(json_decode($request->getBody()->getContents(), true)); // Process uploaded files $uploadMiddleware = new UploadMiddleware(); $request = $uploadMiddleware->processRequest($request); // Execute request and emits response $server = new StandardServer(/* your config here */); $result = $server->executePsrRequest($request); $server->getHelper()->sendResponse($result);
在模式中的使用
然后你可以在你的突变中使用,如下所示
<?php use GraphQL\Type\Definition\ObjectType; use GraphQL\Type\Definition\Type; use GraphQL\Type\Schema; use GraphQL\Upload\UploadType; use Psr\Http\Message\UploadedFileInterface; // Build your Schema $schema = new Schema([ 'query' => new ObjectType([ 'name' => 'Query', ]), 'mutation' => new ObjectType([ 'name' => 'Mutation', 'fields' => [ 'testUpload' => [ 'type' => Type::string(), 'args' => [ 'text' => Type::string(), 'file' => new UploadType(), ], 'resolve' => function ($root, array $args): string { /** @var UploadedFileInterface $file */ $file = $args['file']; // Do something with the file $file->moveTo('some/folder/in/my/project'); return 'Uploaded file was ' . $file->getClientFilename() . ' (' . $file->getClientMediaType() . ') with description: ' . $args['text']; }, ], ], ]), ]);
限制
- 它只支持 PSR-7 请求。如果你尚未使用 PSR-7,zend-diactoros 是创建 PSR-7 请求的多种实现之一。