| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 2644 |
| Technical Name |
odoo_graphql |
| License | See License tab |
| Website | https://github.com/divad1196/odoo_graphql |
| Versions | 17.0 14.0 15.0 16.0 |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 2644 |
| Technical Name |
odoo_graphql |
| License | See License tab |
| Website | https://github.com/divad1196/odoo_graphql |
| Versions | 17.0 14.0 15.0 16.0 |
Generic graphql implementation for Odoo
Use all the power of Odoo in the simpliest way through graphql.
Graphql provides a simpler and more efficient way to query data than you would currently do in Odoo (using for example xmlrpc or jsonrpc).
This module adds a generic way to do graphql queries and mutations on Odoo server.
This module takes into account any installed modules and use the Odoo permissions (Access rights and access rules).
-
Use Odoo as your centralized database for your automations.
Odoo has the easiest backend framework to develop with, and an active and growing community
-
If you want to create your own website on top of Odoo using the most modern framework as AngularJS, VueJS or ReactJs,
This module will provide you the simplest and most efficient way to do your queries.
DISCLAIMER: To do your own website using Odoo, you will need to handle cors.
More information are provided on the readme when you download this module, but you can already have the main information here: https://github.com/divad1196/odoo_nginx_proxy
Author's notes
If you have any issue, encounter a bug or have a feature proposal, please contact me on Github by creating an issue.
You don't have to be a technical person for it.
The project being stable, you won't see a lot of changes in the repository, but the module is still actively maintained.
This is why I need your feedbacks to improve this module.
Despite the license of this project, it seems that some people stole most of its code and started to sell it.
(The worst is certainly that they claim to support open source.)
Please, contribute to open source by sparing your money.
Use cases
-
Use Odoo as your centralised database for your automations.
Odoo has the easiest backend framework to develop with, and an active and growing community
-
If you want to create your own website on top of Odoo using the most modern framework as AngularJS, VueJS or ReactJs,
This module will provide you the simplest and most efficient way to do your queries.
DISCLAIMER: To do your own website using Odoo, you will need to handle cors.
More information are provided on the readme when you download this module, but you can already have the main information here: https://github.com/divad1196/odoo_nginx_proxy
What are the differences with other solutions?
-
Flat Learning curve: The GraphQL arguments are done in a way that any Odoo developer will feel at home.
- Genericity: You don't want to update your GraphQL models for each module you install.
- Maintenance: You don't want to duplicate your code, as Odoo Model AND GraphQL model. You also don't want to update your GraphQL models for each module you install.
- Performance: By coding it yourself, you MAY have better performances, but you will PROBABLY have lower ones. The query processing is made in the best way possible be by wrapping Odoo's ORM.
- Spare Time (and thus money): You want to focus on the use of the data, not how you gather them.
Security and Performance
The security policy is the one already defined by Odoo. You cannot get more information using GraphQL than you would by using jsonrpc/xmlrpc. (This module will be extended with a per-fields access policy in a near future, but as long as RPC is allowed, this won't be any game-changer in terms of security) Those security policies must not be by-passed, which may be done by a developer for any (bad) reason.
The security policies in Odoo add an overhead on each request. This module optimize the search, especially for multi-level queries.
Usage
You can perfom queries
As well as mutations
Using any languages
Examples are provided under the examples/ folder. Inside of which you will find a libs/ folder containing utilities for python and javascript.
Please, take a look at it if you have any questions.
GraphiQL
GraphiQl Editor is integrated
It is DISABLED BY DEFAULT
(read the README.md file in the module to know more about it)Contact
If you are facing any issue with this module, you can contact me on
Github
(https://github.com/divad1196/odoo_graphql/issues)
Make sure that you have read the README file and checked the examples folder first.
Also, feel free to leave a feedback in the comment and rate this module!
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.
Please log in to comment on this module
Report comment
Any abuse of this reporting system will be penalizedAwesome addon!
Awesome addon and a lot of the functionality works out of the box. My only issue is trying to authenticate with Odoo for the graphql to perform queries as a user through postman or python.
I've seen stuff on xmlrpc on authenticating but idk how to go from that to making a query as a user through the endpoint
Excellent addon
Excellent addon, everything works as it should. Thanks to the author for the reply.
Hello, I'm trying your addon, but it seems to me that either I'm using it wrong or there is some problem somewhere. I'm trying it from Python as follows:
```python
import requests
query = """
{
ResPartner(name: "Nicole Ford") {
name
}
}
"""
resp = requests.post('http://localhost:8069/graphql/',
headers={'content-type': 'application/graphql'},
data=query
)
print(resp.text)
```
The result is:
```python
{"data": {"respPartner": []}}
```
Please, where could be the problem?
Re:
Hi, thank you for trying this module.
Before answering, please note the following "Every report of a problem experienced while using the module should be addressed to the author directly". I would appreciate that those kind of questions are done on github.
For your question, there are 2 things wrong:
'ResPartner(name: "Nicole Ford")': name is not a valid option. The options availables are the one of the search method (domain, order, limit, ...)
(see search documentation here: https://www.odoo.com/documentation/15.0/fr/developer/reference/backend/orm.html#odoo.models.Model.search)
In your case, if you want to get someone with this exact name you would need:
'ResPartner(domain: [ ["name", "=", "Nicole Ford"]])'
But you could also use it find part of it and case-insensitive
'ResPartner(domain: [ ["name", "ilike", "nicole%"]])'
Etc.
You are probably not authenticated. This module lets you do query without authentication but you will be considered as a public user. You may get public logs, e-shop products data, etc but not much more.
If you need to be logged, you will need to log first and keep the cookies.
For that you can use requests.Session (https://docs.python-requests.org/en/master/user/advanced/) and you need to make a first query to /web/session/authenticate.
You have an example here in Js: https://github.com/divad1196/odoo_graphql/blob/14.0/odoo_graphql/tests/graphql.js#L2
You could also take a look at the first 5-6 minutes of this video (using postman): https://www.youtube.com/watch?v=wGvuRbCyytk
Most of it explained in the module's README.md file, and full working example is provided in js, but I agree that it could have be clearer. I will make some changes to clarify it and provide full working examples for python.
test