GraphQL

GraphQL 组件对 thecodingmachine/graphqlite 进行抽象。

安装

  1. composer require hyperf/graphql

快速开始

简单查询

  1. <?php
  3. namespace App\Controller;
  5. use GraphQL\GraphQL;
  6. use GraphQL\Type\Schema;
  7. use Hyperf\Di\Annotation\Inject;
  8. use Hyperf\GraphQL\Annotation\Query;
  9. use Hyperf\HttpServer\Annotation\Controller;
  10. use Hyperf\HttpServer\Annotation\PostMapping;
  11. use Hyperf\HttpServer\Contract\RequestInterface;
  13. /**
  14.  * @Controller()
  15.  */
  16. class GraphQLController
  17. {
  18.     /**
  19.      * @Inject()
  20.      * @var Schema
  21.      */
  22.     protected $schema;
  24.     /**
  25.      * @PostMapping(path="/graphql")
  26.      */
  27.     public function test(RequestInterface $request)
  28.     {
  29.         $rawInput = $request->getBody()->getContents();
  30.         $input = json_decode($rawInput, true);
  31.         $query = $input['query'];
  32.         $variableValues = isset($input['variables']) ? $input['variables'] : null;
  33.         return GraphQL::executeQuery($this->schema, $query, null, null, $variableValues)->toArray();
  34.     }
  36.     /**
  37.      * @Query()
  38.      */
  39.     public function hello(string $name): string
  40.     {
  41.         return $name;
  42.     }
  43. }

查询:

  1. {
  2.     hello(name: "graphql")
  3. }

响应:

  1. {
  2.     "data": {
  3.         "hello": "graphql"
  4.     }
  5. }

类型映射

  1. <?php
  2. namespace App\Model;
  4. use Hyperf\GraphQL\Annotation\Type;
  5. use Hyperf\GraphQL\Annotation\Field;
  7. /**
  8.  * @Type()
  9.  */
  10. class Product
  11. {
  12.     protected $name;
  13.     protected $price;
  15.     public function __construct(string $name, float $price)
  16.     {
  17.         $this->name = $name;
  18.         $this->price = $price;
  19.     }
  21.     /**
  22.      * @Field()
  23.      */
  24.     public function getName(): string
  25.     {
  26.         return $this->name;
  27.     }
  29.     /**
  30.      * @Field()
  31.      */
  32.     public function getPrice(): ?float
  33.     {
  34.         return $this->price;
  35.     }
  36. }

在 GraphQLController 中加入

  1. <?php
  2. use App\Model\Product;
  4. /**
  5.  * @Query()
  6.  */
  7. public function product(string $name, float $price): Product
  8. {
  9.     return new Product($name, $price);
  10. }

查询:

  1. {
  2.     hello(name: "graphql")
  3.     product(name: "goods", price: 156.5) {
  4.         name
  5.         price
  6.     }
  7. }

响应:

  1. {
  2.     "data": {
  3.         "hello": "graphql",
  4.         "product": {
  5.             "name": "goods",
  6.             "price": 156.5
  7.         }
  8.     }
  9. }

更多使用方法可以查看 GraphQLite 的文档。