Пользовательские ключи карты в ответе GraphQL

Question

Я искал GraphQL в качестве замены некоторых API-интерфейсов REST, и, хотя я думаю, что я обернул голову вокруг основ и, как и большинство из того, что я вижу до сих пор, одна важная функция, которая, кажется, отсутствует.

Скажем, у меня есть коллекция предметов, как это:

{ 
    "id": "aaa", 
    "name": "Item 1", 
    ... 
} 

Приложение нужна карта всех этих объектов, индексируются ID, как например:

{ 
    "allItems": { 
     "aaa": { 
      "name": "Item 1", 
      ... 
     }, 
     "aab": { 
      "name": "Item 2", 
      ... 
     } 
    } 
} 

Каждый API I «когда-либо написанный, смог вернуть результаты в таком формате, но я изо всех сил пытаюсь найти способ сделать это с помощью GraphQL. Я продолжаю работать через issue 101, но это больше связано с неизвестными схемами. В моем случае я точно знаю, что такое все поля; это чисто формат вывода. Я знаю, что могу просто вернуть все элементы в массиве и переформатировать его на стороне клиента, но это похоже на излишний прилив, учитывая, что он никогда не был нужен в прошлом и заставил GraphQL чувствовать себя как шаг назад. Я не уверен, что то, что я пытаюсь сделать, невозможно, или я просто использую неправильную терминологию. Должен ли я продолжать копать, или GraphQL просто не подходит для моих нужд? Если это возможно, что может выглядеть запрос для получения таких данных?

В настоящее время я работаю с graphql-php на сервере, но я открыт для более концептуальных ответов более высокого уровня.

Answer 1

К сожалению, возвращение объектов с произвольными и динамическими ключами, как это, на самом деле не является первоклассным гражданином в GraphQL. Это не значит, что вы не можете достичь того же, но при этом вы потеряете много преимуществ GraphQL.

Если вы хотите вернуть объект с ключами id вместо того, чтобы возвращать коллекцию/список объектов, содержащих идентификаторы, а затем делать преобразование на клиенте, то вы можете создать специальный GraphQLScalarType.

const GraphQLAnyObject = new GraphQLScalarType({ 
    name: 'AnyObject', 
    description: 'Any JSON object. This type bypasses type checking.', 
    serialize: value => { 
    return value; 
    }, 
    parseValue: value => { 
    return value; 
    }, 
    parseLiteral: ast => { 
    if (ast.kind !== Kind.OBJECT) { 
     throw new GraphQLError("Query error: Can only parse object but got a: " + ast.kind, [ast]); 
    } 
    return ast.value; 
    } 
}); 

Проблема такого подхода заключается в том, что, поскольку он является скалярный тип, вы не можете поставить выбор набора для запроса его. НАПРИМЕР. если у вас тип

type MyType implements Node { 
    id: ID! 
    myKeyedCollection: AnyObject 
} 

Тогда вы бы только иметь возможность запросить его, как так

query { 
    getMyType(id: abc) { 
    myKeyedCollection # note there is no { ... } 
    } 
} 

Как уже сказал, я не рекомендовал бы это, потому что вы теряете много преимуществ GraphQL, но он показывает, что GraphQL все еще может делать что угодно, что может сделать REST. Если вы просто хотите попробовать, мы предоставляем типы AnyObject на scaphold.io, с которыми вы можете играть.

Надеюсь, это поможет!