odoo接口

### Odoo API 接口的使用与开发 Odoo 提供了多种方式用于实现 API 接口的功能，主要分为基于控制器（Controllers）的方式以及模型层（Models）的方法。以下是关于这两种方式的具体说明： #### 基于 Controllers 的接口开发 在 Odoo 中，`http.Controller` 类可以用来定义 HTTP 路由并处理请求。这种方式适合构建 RESTful 风格的 API 接口。 以下是一个简单的例子[^3]： ```python import json from odoo import http from odoo.http import request class GetPartner(http.Controller): @http.route('/api/partner', type='http', auth='user', methods=['GET'], csrf=False) def partner(self, **kw): keywords = kw.get('keywords') or '' domain = [ ('company_id', 'in', [1, request.env.user.company_id.id]), ('customer', '=', True) ] if keywords: domain += [('name', 'ilike', keywords)] partner_records = request.env['res.partner'].with_context({'search_default_customer': 1}).search(domain, limit=80) result = [] for record in partner_records: result.append({ 'id': record.id, 'text': record.name, }) return json.dumps(result) ``` 在这个示例中，我们创建了一个 `/api/partner` 的路由，允许用户通过 GET 请求获取客户列表。该接口支持关键词过滤功能，并返回 JSON 数据作为响应。 --- #### 基于 Models 层的接口开发 另一种常见的方法是在 `models` 下定义业务逻辑并通过 RPC 或其他机制调用这些方法。这种方法更适合内部系统的集成需求。 下面展示如何在一个自定义模块中定义一个模型及其方法[^1]： ```python from odoo import models, api class TestApi(models.Model): _name = 'test.api' _description = 'Test API' @api.model def add_data(self, vals): """ 添加数据到系统中的某个表单或其他资源。 :param vals: 输入参数字典 :return: 返回成功状态码及消息 """ print(vals) return {"code": "0", "value": "success"} ``` 此代码片段展示了如何在模型中定义一个名为 `add_data` 的方法，它接受外部传入的数据并执行某些操作。可以通过 XML-RPC 或 JSON-RPC 协议远程调用此类方法。 --- #### 关于 RESTful API 的设计原则 RESTful API 是一种流行的 Web 开发模式，其核心理念是以资源为中心进行交互。以下是几个关键特性[^2]： - **轻量化通信**：仅依赖 HTTP 协议即可完成所有的 CRUD 操作（POST、GET、PUT 和 DELETE），无需引入额外的复杂协议。 - **清晰易懂**：URL 结构直观明了，便于开发者理解和维护。 - **灵活的数据格式**：通常采用 JSON 或 XML 格式传递数据，简化客户端和服务端之间的沟通成本。 例如，在实际项目中可能需要提供如下 URL 来管理订单信息： - 创建新订单：`POST /orders` - 查询特定订单详情：`GET /orders/{order_id}` - 更新现有订单：`PUT /orders/{order_id}` - 删除指定订单：`DELETE /orders/{order_id}` --- #### 安全性和权限控制 无论是哪种类型的 API 接口，安全性都是不可忽视的重要环节。Odoo 支持多种认证授权策略，比如公共访问 (`auth='public'`) 和受限访问 (`auth='user'`) 等[^3]。对于敏感的操作建议始终启用用户级别的验证以保护企业数据不被非法篡改或泄露。 ---