Package: odoo12-addon-graphql-base
This modules enables the creation ofGraphQLendpoints.
In itself, it does nothing and must be used by a developer to
create the GraphQL schema and resolvers usinggraphene,
and expose them through a controller.
An example is available in thegraphql_demomodule.Table of contentsUsageBuilding your schemaCreating GraphQL controllersBug TrackerCreditsAuthorsMaintainersUsageTo use this module, you need tocreate your graphene schemacreate your controller to expose your GraphQL endpoint,
and optionally a GraphiQL IDE.This module does not attempt to expose the whole Odoo object model.
This could be the purpose of another module based on this one.
We believe however that it is preferable to expose a specific well tested
endpoint for each customer, so as to reduce coupling by knowing precisely
what is exposed and needs to be tested when upgrading Odoo.To start working with this module, we recommend the following approach:LearnGraphQL basicsLearngraphene, the python library
used to create GraphQL schemas and resolvers.Examine thegraphql_demomodule in this repo, copy it,
adapt the controller to suit your needs (routes, authentication methods).Start building your own schema and resolver.Building your schemaThe schema can be built using native graphene types.
Anodoo.addons.graphql_base.types.OdooObjectTypeis provided as a convenience. It is a grapheneObjectTypewith a
default attribute resolver which:converts False to None (except for Boolean types), to avoid Odoo’s weirdFalsestrings being rendered as json"false";adds the user timezone to Datetime fields;raises an error if an attribute is absent to avoid field name typing errors.Creating GraphQL controllersThe module provides anodoo.addons.graphql_base.GraphQLControllerMixinclass to help you build GraphQL controllers providing GraphiQL and/or GraphQL
endpoints.fromodooimporthttpfromodoo.addons.graphql_baseimportGraphQLControllerMixinfrom..schemaimportschemaclassGraphQLController(http.Controller,GraphQLControllerMixin):# The GraphiQL route, providing an IDE for developers@http.route("/graphiql/demo",auth="user")defgraphiql(self,**kwargs):returnself._handle_graphiql_request(schema)# Optional monkey patch, needed to accept application/json GraphQL# requests. If you only need to accept GET requests or POST# with application/x-www-form-urlencoded content,# this is not necessary.GraphQLControllerMixin.patch_for_json("^/graphql/demo/?$")# 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)defgraphql(self,**kwargs):returnself._handle_graphql_request(schema)Bug TrackerBugs are tracked onGitHub Issues.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomedfeedback.Do not contact contributors directly about support or help with technical issues.CreditsAuthorsACSONE SA/NVMaintainersThis module is maintained by the OCA.OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.Currentmaintainer:This module is part of theOCA/rest-frameworkproject on GitHub.You are welcome to contribute. To learn how please visithttps://odoo-community.org/page/Contribute.