基础GraphQL/GraphiQL控制器
项目描述
此模块允许创建GraphQL端点。本身不执行任何操作,需要由开发者使用graphene创建GraphQL模式和解析器,并通过控制器公开。在graphql_demo模块中提供了一个示例。
目录
使用
要使用此模块,您需要
创建您的graphene模式
创建您的控制器以公开您的GraphQL端点,可选的GraphiQL IDE。
此模块不尝试公开整个Odoo对象模型。这可能是基于此模块的另一个模块的目的。然而,我们认为公开每个客户的具体、经过良好测试的端点更为可取,这样可以减少耦合,在升级Odoo时可以精确地知道哪些内容被公开和需要测试。
要开始使用此模块,我们建议以下方法
学习graphene,用于创建GraphQL模式和解析器的Python库。
检查此存储库中的graphql_demo模块,复制它,根据您的需求调整控制器(路由、认证方法)。
开始构建您自己的模式和解析器。
构建您的模式
可以使用原生graphene类型构建模式。提供了一个方便的odoo.addons.graphql_base.types.OdooObjectType。它是一个具有默认属性解析器的graphene ObjectType,该解析器
将False转换为None(布尔类型除外),以避免Odoo的怪异字符串False在json中表示为"false";
将用户时区添加到DateTime字段;
如果缺少属性则引发错误,以避免字段名输入错误。
创建GraphQL控制器
该模块提供了一个odoo.addons.graphql_base.GraphQLControllerMixin类,以帮助您构建提供GraphiQL和/或GraphQL端点的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)
# 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)
def graphql(self, **kwargs):
return self._handle_graphql_request(schema)
错误跟踪器
错误在GitHub Issues上跟踪。如果在那里找不到您的问题报告,请检查。如果您是第一个发现它的,请通过提供详细和受欢迎的反馈来帮助我们。
请不要直接联系贡献者以寻求支持或帮助解决技术问题。
致谢
维护者
该模块由OCA维护。
OCA,或Odoo社区协会,是一个非营利组织,其使命是支持Odoo功能的协作开发并促进其广泛使用。
当前维护者
该模块是GitHub上的OCA/rest-framework项目的组成部分。
欢迎您贡献力量。有关如何贡献的更多信息,请访问https://odoo-community.org/page/Contribute。
项目详情
哈希 for odoo12_addon_graphql_base-12.0.2.0.1-py3-none-any.whl
算法 | 哈希摘要 | |
---|---|---|
SHA256 | b3be2fa6dd75b0ae8f2ad93e1ebada9d72c84d632f9ce1501978cfdf6ddc14a3 |
|
MD5 | 14d1125a33a47a0190d28160573c67b6 |
|
BLAKE2b-256 | 54f7b3f1b51c4d82e9627c0b7234b07db69fc2e3012eef7c04f783c41d52648d |