Graphql

Consultas e mutações GraphQL sobre a API do projeto.

Classe Graphql: 2 métodos (2 no @owbase/web, 2 no @owbase/node). Os exemplos usam a forma de objeto dos parâmetros; troque os valores entre < e > pelos seus.

query

Endpoint GraphQL

SDK: @owbase/web e @owbase/node

Executa uma consulta GraphQL.

Parâmetro	Tipo	Obrigatório	Descrição
query	object	sim	A consulta ou as consultas a executar.

Acesso: chave de API com o escopo graphql ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

import { Client, Graphql } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const graphql = new Graphql(client);

const result = await graphql.query({
    query: {
        query: 'query { localeGet { ip } }',
    },
});

console.log(result);

@owbase/node

import { Client, Graphql } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const graphql = new Graphql(client);

const result = await graphql.query({
    query: {
        query: 'query { localeGet { ip } }',
    },
});

mutation

Endpoint GraphQL

SDK: @owbase/web e @owbase/node

Executa uma mutation GraphQL.

Parâmetro	Tipo	Obrigatório	Descrição
query	object	sim	A consulta ou as consultas a executar.

Acesso: chave de API com o escopo graphql ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

import { Client, Graphql } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const graphql = new Graphql(client);

const result = await graphql.mutation({
    query: {
        query: 'mutation { accountUpdateName(name: "Walter") { name } }',
    },
});

console.log(result);

@owbase/node

import { Client, Graphql } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const graphql = new Graphql(client);

const result = await graphql.mutation({
    query: {
        query: 'mutation { accountUpdateName(name: "Walter") { name } }',
    },
});

---

As descrições desta página são traduções das que vêm da especificação da API do servidor (licença BSD-3-Clause), e os exemplos vêm do gerador de SDKs (licença MIT). Os avisos completos estão no arquivo NOTICE dos pacotes @owbase/web e @owbase/node.