• odoo base_rest_demo,restfulAPI 的理解


    重点:

    以partner 的api接口为例:

    # Copyright 2018 ACSONE SA/NV
    # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
    from odoo.addons.base_rest.components.service import to_bool, to_int
    from odoo.addons.component.core import Component
    
    
    class PartnerService(Component):
        _inherit = "base.rest.service"
        _name = "partner.service"
        _usage = "partner"
        _collection = "base.rest.demo.private.services"
        _description = """
            Partner Services
            Access to the partner services is only allowed to authenticated users.
            If you are not authenticated go to <a href='/web/login'>Login</a>
        """
    
        def get(self, _id):
            """
            Get partner's informations
            """
            return self._to_json(self._get(_id))
    
        def search(self, name):
            """
            Searh partner by name
            """
            partners = self.env["res.partner"].name_search(name)
            partners = self.env["res.partner"].browse([i[0] for i in partners])
            rows = []
            res = {"count": len(partners), "rows": rows}
            for partner in partners:
                rows.append(self._to_json(partner))
            return res
    
        # pylint:disable=method-required-super
        def create(self, **params):
            """
            Create a new partner
            """
            partner = self.env["res.partner"].create(self._prepare_params(params))
            return self._to_json(partner)
    
        def update(self, _id, **params):
            """
            Update partner informations
            """
            partner = self._get(_id)
            partner.write(self._prepare_params(params))
            return self._to_json(partner)
    
        def archive(self, _id, **params):
            """
            Archive the given partner. This method is an empty method, IOW it
            don't update the partner. This method is part of the demo data to
            illustrate that historically it's not mandatory to defined a schema
            describing the content of the response returned by a method.
            This kind of definition is DEPRECATED and will no more supported in
            the future.
            :param _id:
            :param params:
            :return:
            """
            return {"response": "Method archive called with id %s" % _id}
    
        # The following method are 'private' and should be never never NEVER call
        # from the controller.
    
        def _get(self, _id):
            return self.env["res.partner"].browse(_id)
    
        def _prepare_params(self, params):
            for key in ["country", "state"]:
                if key in params:
                    val = params.pop(key)
                    if val.get("id"):
                        params["%s_id" % key] = val["id"]
            return params
    
        # Validator
        def _validator_return_get(self):
            res = self._validator_create()
            res.update({"id": {"type": "integer", "required": True, "empty": False}})
            return res
    
        def _validator_search(self):
            return {"name": {"type": "string", "nullable": False, "required": True}}
    
        def _validator_return_search(self):
            return {
                "count": {"type": "integer", "required": True},
                "rows": {
                    "type": "list",
                    "required": True,
                    "schema": {"type": "dict", "schema": self._validator_return_get()},
                },
            }
    
        def _validator_create(self):
            res = {
                "name": {"type": "string", "required": True, "empty": False},
                "street": {"type": "string", "required": True, "empty": False},
                "street2": {"type": "string", "nullable": True},
                "zip": {"type": "string", "required": True, "empty": False},
                "city": {"type": "string", "required": True, "empty": False},
                "phone": {"type": "string", "nullable": True, "empty": False},
                "state": {
                    "type": "dict",
                    "schema": {
                        "id": {"type": "integer", "coerce": to_int, "nullable": True},
                        "name": {"type": "string"},
                    },
                },
                "country": {
                    "type": "dict",
                    "schema": {
                        "id": {
                            "type": "integer",
                            "coerce": to_int,
                            "required": True,
                            "nullable": False,
                        },
                        "name": {"type": "string"},
                    },
                },
                "is_company": {"coerce": to_bool, "type": "boolean"},
            }
            return res
    
        def _validator_return_create(self):
            return self._validator_return_get()
    
        def _validator_update(self):
            res = self._validator_create()
            for key in res:
                if "required" in res[key]:
                    del res[key]["required"]
            return res
    
        def _validator_return_update(self):
            return self._validator_return_get()
    
        def _validator_archive(self):
            return {}
    
        def _to_json(self, partner):
            res = {
                "id": partner.id,
                "name": partner.name,
                "street": partner.street,
                "street2": partner.street2 or "",
                "zip": partner.zip,
                "city": partner.city,
                "phone": partner.city,
            }
            if partner.country_id:
                res["country"] = {
                    "id": partner.country_id.id,
                    "name": partner.country_id.name,
                }
            if partner.state_id:
                res["state"] = {"id": partner.state_id.id, "name": partner.state_id.name}
            return res
    
    

    说明:

    1. 每新建一个方法后,都需要同时新建一个对应的验证方法,以_validator_开头,比如定义了一个get方法,则需要同时定义一个_validator_get方法
      如果没有对应的方法,则会报错.AttributeError: 'NoneType' object has no attribute 'items' - - -
  • 相关阅读:
    HttpContext.GetOwinContext().Authentication 报错 解决办法
    owin Claims-based认证登录实现
    angularjs初识ng-app、ng-model、ng-repeat指令
    SpringBoot配置slf4j logback-spring.xml日志
    idea时间注释模版
    oracel截取字符串
    win10官网下载地址
    使用HttpWebRequest实现basic身份认证
    mybatis常用jdbcType数据类型与mysql的类型对照
    修改IntelliJ IDEA 默认配置路径
  • 原文地址:https://www.cnblogs.com/qianxunman/p/13190890.html
走看看 - 开发者的网上家园