如何更改/自定义 Lighthouse 的响应格式？

Question

我正在为我的应用程序使用灯塔 GraphQL 和 Laravel 9。 Graphql 具有标准格式，每个响应显示在数据和操作名称下。 它没有显示正确的响应（错误/成功）来处理前端应用程序。 因为，基于错误代码，iOS/Android/前端可能很容易工作。 这是示例：请求：

query Translations {
        translations {
            name
            slug
        }
    }

回复：

{
        "data": {
            "translations": [
                {
                    "name": "English",
                    "slug": "en_US"
                },
                {
                    "name": "English (United Kingdom)",
                    "slug": "en_UK"
                }      
            ]
        }
    }

我试图用 Laravel 响应类覆盖响应并创建自定义查询/突变解析器。 但是，它返回所有信息。 这也应该使用 Graphql“定制您的需要”。 所以，我想自定义响应，使响应包含代码、状态、消息、数据[]。

我得到的结果：

{
        "status": true,
        "code": 200,
        "message": "",
        "data": [
            {
                "_id": "63b2d767e2a07754b20845f6",
                "name": "English",
                "slug": "en_US",
                "isActive": true,
                "isDefault": true,
                "updated_at": "2023-01-02T13:08:54.940000Z",
                "created_at": "2023-01-02T13:08:54.940000Z",
                "logo": "/United-States.svg"
            },
            {
                "_id": "63b3e78ae2a07754b20845ff",
                "name": "English (United Kingdom)",
                "slug": "en_UK",
                "isActive": true,
                "isDefault": false,
                "updated_at": "2023-01-03T08:30:02.085000Z",
                "created_at": "2023-01-03T08:30:02.085000Z",
                "logo": "/Great-Britain.svg"
            } 
        ]
    }

它应该是：

{
        "status": true,
        "code": 200,
        "message": "",
        "data": [
            {     
                "name": "English",
                "slug": "en_US"      
            },
            {      
                "name": "English (United Kingdom)",
                "slug": "en_UK"      
            }    
        ]
    }

Answer 1

Lighthouse 返回基于GraphQL 规范的响应。 您有权使用EndRequest事件更改响应。 侦听AppServiceProvider中的事件，然后以您需要的任何形式操作响应。

/**
 * @param Dispatcher $dispatcher
 *
 * @return void
 */
public function boot(Dispatcher $dispatcher): void {
    $dispatcher->listen(
        EndRequest::class,
        function (EndRequest $endRequest) {
            dd($endRequest->response);
        });
}

Answer 2

它应该是：

{
        "status": true,
        "code": 200,
        "message": "",
        "data": [
            {     
                "name": "English",
                "slug": "en_US"      
            },
            {      
                "name": "English (United Kingdom)",
                "slug": "en_UK"      
            }    
        ]
    }

我强烈反对这样做，因为它违反了GraphQL 规范：

为确保未来对协议的更改不会破坏现有服务和客户端，顶级响应 map 不得包含除上述三个以外的任何条目。

使用extensions来自定义添加。 您可以通过监听BuildExtensionsResponse事件添加到 Lighthouse 中的扩展，请参阅https://lighthouse-php.com/master/api-reference/events.html#buildextensionsresponse