Skip to Content

GraphQL API for Odoo

by

83.92

17.0 0
Live Preview
Required Apps Discuss (mail)
Community Apps Dependencies api_auth_apikey
api_framework_base
ekika_utils
ekika_widgets
Technical Name easy_graphql
License OPL-1
Also available in version 18.0 17.0 16.0
You bought this module and need support ? Click here!
Technical Name easy_graphql
License OPL-1
Also available in version v 18.0 v 17.0 v 16.0

Introduction

The Odoo Easy GraphQL module brings powerful GraphQL capabilities to your Odoo environment, allowing the definition of expressive and efficient query and mutation endpoints. It supports accessing and manipulating Odoo data using a unified API schema—making it easier to integrate with modern front-end frameworks and external systems. This framework bridges the gap between Odoo and technology stacks that expect flexible, structured API access.

Key Features

  • Define GraphQL endpoints based on Odoo models and business logic

  • Support for both queries (read) and mutations (create, update, delete) in a structured format

  • Flexible configuration for exposing specific fields and operations with fine-grained control

  • Integration with Odoo’s permission system to enforce model-level access rights

  • Designed to work seamlessly with GraphiQL tools for development and testing

Benefits

  • Simplifies API development with a standardized, modern interface for external integrations

  • Reduces load and improves performance by allowing clients to request only needed data

  • Enhances developer experience through self-descriptive schemas and intuitive operations

  • Maintains security and control by adhering to Odoo’s existing rules and access mechanisms

  • Facilitates building reactive web and mobile applications with real-time data capabilities

Compatibility & Technical Details

Technical Name: easy_graphql

License: LGPL-3

Required Modules:

  • GraphQL API base module

  • GraphQL controller and schema framework

  • Core Odoo modules dealing with data models, HTTP routing, and access control

Installation Steps:

  1. Ensure the base GraphQL framework and supporting modules are installed.

  2. Add the easy_graphql module to your Odoo Add-Ons directory.

  3. Activate Developer Mode and update the app list.

  4. Install the module through the Apps interface.

  5. Configure GraphQL schema by specifying models, queries, and mutations to expose.

  6. Secure the API access as needed and test using a GraphiQL interface for development.

Odoo Proprietary License v1.0
This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.