odoo13-addon-base-rest 13.0.3.1.4

配置

如果在调用服务方法（例如缺少参数）时发生错误，则系统仅返回问题的一般描述，而不提供详细信息。这是故意为之，以确保在实现细节上最大程度的透明度，从而降低安全风险。

当服务由开发中的外部系统访问时，这种限制可能会出现问题。要了解错误详情，确实需要访问服务器的日志。并不总是有可能提供这种类型的访问。这就是为什么您可以配置服务器在开发模式下运行这些服务的原因。

要在开发模式下运行REST API，您必须在服务器配置文件中添加一个新部分“【base_rest】”，并选择“dev_mode=True”。

[base_rest]
dev_mode=True

当REST API以开发模式运行时，在出错的情况下将返回原始描述和堆栈跟踪。请注意，不要在生产环境中使用此模式。

用法

要添加自己的REST服务，您必须提供至少2个类。

• 一个提供您服务业务逻辑的组件，

• 一个用于注册您的服务的控制器。

您的服务的业务逻辑必须实现为一个组件（odoo.addons.component.core.Component），它继承自“base.rest.service”

最初，base_rest默认公开服务中定义的所有公共方法。通过HTTP访问方法的约定如下

• 如果定义了方法 def get(self, _id)，则可以通过HTTP GET路由 <string:_service_name>/<int:_id> 和 <string:_service_name>/<int:_id>/get 访问。

• 如果定义了方法 def search(self, **params)，则可以通过HTTP GET路由 <string:_service_name>/ 和 <string:_service_name>/search 访问。

• 如果定义了方法 def delete(self, _id)，则可以通过HTTP DELETE路由 <string:_service_name>/<int:_id> 访问。

• 如果定义了方法 def update(self, _id, **params)，则可以通过HTTP PUT路由 <string:_service_name>/<int:_id> 访问。

• 其他方法只能通过HTTP POST路由 <string:_service_name> 或 <string:_service_name>/<string:method_name> 或 <string:_service_name>/<int:_id> 或 <string:_service_name>/<int:_id>/<string:method_name> 访问。

from odoo.addons.component.core import Component


class PingService(Component):
    _inherit = 'base.rest.service'
    _name = 'ping.service'
    _usage = 'ping'
    _collection = 'my_module.services'


    # The following method are 'public' and can be called from the controller.
    def get(self, _id, message):
        return {
            'response': 'Get called with message ' + message}

    def search(self, message):
        return {
            'response': 'Search called search with message ' + message}

    def update(self, _id, message):
        return {'response': 'PUT called with message ' + message}

    # pylint:disable=method-required-super
    def create(self, **params):
        return {'response': 'POST called with message ' + params['message']}

    def delete(self, _id):
        return {'response': 'DELETE called with id %s ' % _id}

    # Validator
    def _validator_search(self):
        return {'message': {'type': 'string'}}

    # Validator
    def _validator_get(self):
        # no parameters by default
        return {}

    def _validator_update(self):
        return {'message': {'type': 'string'}}

    def _validator_create(self):
        return {'message': {'type': 'string'}}

一旦实现了您的服务（ping等），就必须告诉Odoo如何访问这些服务。此过程通过实现一个继承自 odoo.addons.base_rest.controllers.main.RestController 的控制器来完成。

from odoo.addons.base_rest.controllers import main

class MyRestController(main.RestController):
    _root_path = '/my_services_api/'
    _collection_name = my_module.services

在您的控制器中，_’root_path’ 用于指定访问您服务的路径根，而 ‘_collection_name’ 是提供请求服务的业务逻辑的集合名称。

通过继承自 RestController，以下路由将被注册以访问您的服务

@route([
    ROOT_PATH + '<string:_service_name>',
    ROOT_PATH + '<string:_service_name>/search',
    ROOT_PATH + '<string:_service_name>/<int:_id>',
    ROOT_PATH + '<string:_service_name>/<int:_id>/get'
], methods=['GET'], auth="user", csrf=False)
def get(self, _service_name, _id=None, **params):
    method_name = 'get' if _id else 'search'
    return self._process_method(_service_name, method_name, _id, params)

@route([
    ROOT_PATH + '<string:_service_name>',
    ROOT_PATH + '<string:_service_name>/<string:method_name>',
    ROOT_PATH + '<string:_service_name>/<int:_id>',
    ROOT_PATH + '<string:_service_name>/<int:_id>/<string:method_name>'
], methods=['POST'], auth="user", csrf=False)
def modify(self, _service_name, _id=None, method_name=None, **params):
    if not method_name:
        method_name = 'update' if _id else 'create'
    if method_name == 'get':
        _logger.error("HTTP POST with method name 'get' is not allowed. "
                      "(service name: %s)", _service_name)
        raise BadRequest()
    return self._process_method(_service_name, method_name, _id, params)

@route([
    ROOT_PATH + '<string:_service_name>/<int:_id>',
], methods=['PUT'], auth="user", csrf=False)
def update(self, _service_name, _id, **params):
    return self._process_method(_service_name, 'update', _id, params)

@route([
    ROOT_PATH + '<string:_service_name>/<int:_id>',
], methods=['DELETE'], auth="user", csrf=False)
def delete(self, _service_name, _id):
    return self._process_method(_service_name, 'delete', _id)

因此，对“http://my_odoo/my_services_api/ping”的HTTP GET调用将被分发到方法 PingService.search。

除了轻松公开您的函数外，该模块还允许您定义必须符合的数据模式。这些模式基于 Cerberus schemas 定义，并使用以下命名约定关联到方法。对于方法 my_method

• def _validator_my_method(self): 将被调用以获取验证输入参数所需的模式。

• def _validator_return_my_method(self): 如果定义，将被调用以获取用于验证响应的模式。

为了提供更多的灵活性，开发了一个新的API。

这个新API通过使用Python装饰器显式标记方法作为REST API可用来替换用于公开服务的隐式方法： odoo.addons.base_rest.restapi.method。

class PartnerNewApiService(Component):
    _inherit = "base.rest.service"
    _name = "partner.new_api.service"
    _usage = "partner"
    _collection = "base.rest.demo.new_api.services"
    _description = """
        Partner New API Services
        Services developed with the new api provided by base_rest
    """

    @restapi.method(
        [(["/<int:id>/get", "/<int:id>"], "GET")],
        output_param=restapi.CerberusValidator("_get_partner_schema"),
        auth="public",
    )
    def get(self, _id):
        return {"name": self.env["res.partner"].browse(_id).name}

    def _get_partner_schema(self):
        return {
            "name": {"type": "string", "required": True}
        }

通过这个新API，您现在可以自由指定自己的路由，也可以将其他对象类型用作方法的参数或响应。例如，base_rest_datamodel 允许您在服务中使用Datamodel对象实例。

from marshmallow import fields

from odoo.addons.base_rest import restapi
from odoo.addons.component.core import Component
from odoo.addons.datamodel.core import Datamodel


class PartnerSearchParam(Datamodel):
    _name = "partner.search.param"

    id = fields.Integer(required=False, allow_none=False)
    name = fields.String(required=False, allow_none=False)


class PartnerShortInfo(Datamodel):
    _name = "partner.short.info"

    id = fields.Integer(required=True, allow_none=False)
    name = fields.String(required=True, allow_none=False)


class PartnerNewApiService(Component):
    _inherit = "base.rest.service"
    _name = "partner.new_api.service"
    _usage = "partner"
    _collection = "base.rest.demo.new_api.services"
    _description = """
        Partner New API Services
        Services developed with the new api provided by base_rest
    """

    @restapi.method(
        [(["/", "/search"], "GET")],
        input_param=restapi.Datamodel("partner.search.param"),
        output_param=restapi.Datamodel("partner.short.info", is_list=True),
        auth="public",
    )
    def search(self, partner_search_param):
        """
        Search for partners
        :param partner_search_param: An instance of partner.search.param
        :return: List of partner.short.info
        """
        domain = []
        if partner_search_param.name:
            domain.append(("name", "like", partner_search_param.name))
        if partner_search_param.id:
            domain.append(("id", "=", partner_search_param.id))
        res = []
        PartnerShortInfo = self.env.datamodels["partner.short.info"]
        for p in self.env["res.partner"].search(domain):
            res.append(PartnerShortInfo(id=p.id, name=p.name))
        return res

已知问题/路线图

可以在GitHub上找到 路线图 和 已知问题。

变更日志

错误跟踪器

Bug 跟踪在 GitHub Issues。如有问题，请检查是否已报告您的问题。如果是您首先发现的，请通过提供详细且受欢迎的 反馈 来帮助我们解决它。

请不要直接联系贡献者以获取支持或技术问题的帮助。

鸣谢

维护者

本模块由 OCA 维护。

OCA，即 Odoo 社区协会，是一个非营利组织，其使命是支持 Odoo 功能的协作开发并促进其广泛使用。

当前 维护者

本模块是 GitHub 上的 OCA/rest-framework 项目的一部分。

欢迎您贡献力量。有关如何贡献，请访问 https://odoo-community.org/page/Contribute。