Graphql Base

Para usar este módulo, necesitas

• crear tu esquema graphene
• crear tu controlador para exponer tu endpoint GraphQL y, opcionalmente, un IDE GraphiQL.

Este módulo no intenta exponer todo el modelo de objetos de Odoo. Ese podría ser el propósito de otro módulo basado en este. Creemos sin embargo que es preferible exponer un endpoint específico y bien probado para cada cliente, de modo que se reduzca el acoplamiento al saber con precisión qué se expone y qué necesita ser probado al actualizar Odoo.

Para empezar a trabajar con este módulo, recomendamos el siguiente enfoque:

• Aprende los conceptos básicos de GraphQL
• Aprende graphene, la librería de python utilizada para crear esquemas y resolvers de GraphQL.
• Examina el módulo graphql_demo en este repo, cópialo, adapta el controlador para que se ajuste a tus necesidades (rutas, métodos de autenticación).
• Empieza a construir tu propio esquema y resolver.

Construir tu esquema

El esquema puede construirse usando tipos nativos de graphene. Se proporciona un odoo.addons.graphql_base.types.OdooObjectType como comodidad. Es un ObjectType de graphene con un resolvedor de atributos por defecto que:

• convierte False a None (excepto para tipos Boolean), para evitar que las extrañas cadenas False de Odoo se rendericen como json "false";
• añade la zona horaria del usuario a los campos Datetime;
• lanza un error si un atributo está ausente para evitar errores de escritura en los nombres de los campos.

Crear controladores GraphQL

El módulo proporciona una clase odoo.addons.graphql_base.GraphQLControllerMixin para ayudarte a construir controladores GraphQL que proporcionen endpoints GraphiQL y/o GraphQL.

from odoo import http
from odoo.addons.graphql_base import GraphQLControllerMixin

from ..schema import schema


class GraphQLController(http.Controller, GraphQLControllerMixin):

    # The GraphiQL route, providing an IDE for developers
    @http.route("/graphiql/demo", auth="user")
    def graphiql(self, **kwargs):
        return self._handle_graphiql_request(schema)

    # The graphql route, for applications.
    # Note csrf=False: you may want to apply extra security
    # (such as origin restrictions) to this route.
    @http.route("/graphql/demo", auth="user", csrf=False)
    def graphql(self, **kwargs):
        return self._handle_graphql_request(schema)