【Day15】 odoo 資料庫串接(二) GET

2024 iThome 鐵人賽

DAY 15

Odoo

前後端整合學習，不只是後端管理系列第 15 篇

16th鐵人賽 odoo

weijung0923

2024-09-23 14:33:03

82 瀏覽

分享至

在 Odoo 的開發中，操作資料庫是實現業務邏輯的重要一環。Odoo 的 ORM 系統為開發者提供了簡單而強大的工具，允許開發者通過 Python API 來輕鬆地對資料進行操作，而無需直接編寫 SQL 查詢。本文將以 Odoo 的 Repair 模組為例，展示如何使用 GET 請求來取得維修訂單資料，並展示如何使用 Postman 來測試這些 API。

Repair 模組簡介

Odoo 的 Repair 模組用於管理產品維修訂單。它記錄了維修流程的各個階段，並儲存了與維修相關的所有詳細信息，如產品、客戶、維修狀態、維修成本等。這個模組的核心模型是 repair.order，對應資料表 repair_order，用於存儲所有的維修訂單記錄。

使用 ORM 來取得 Repair 訂單資料

在 Odoo 中，ORM 提供了一個簡單的介面來查詢資料。以下是一個簡單的控制器範例，展示了如何使用 ORM 來取得所有的維修訂單資料，並將其通過 GET 請求返回。

建立控制器來處理 GET 請求：

首先，我們需要建立一個控制器來處理 GET 請求，該請求將返回所有維修訂單的資料。

from odoo import http
from odoo.http import request
import json

class RepairOrderController(http.Controller):

    @http.route('/repair/orders', type='http', auth='public', methods=['GET'], csrf=False)
    def get_repair_orders(self):
        # 使用 sudo 繞過權限檢查，檢索所有維修訂單
        repair_orders = request.env['repair.order'].sudo().search([])

        # 構建 JSON 響應
        order_list = []
        for order in repair_orders:
            order_list.append({
                'id': order.id,
                'name': order.name,
                'product': order.product_id.name,
                'customer': order.partner_id.name,
                'state': order.state,
                # 假設你需要成本，使用 invoice_id 或其他字段替代 repair_fee
                'cost': order.amount_total if hasattr(order, 'amount_total') else 'N/A'
            })

        # 返回 JSON 響應
        return http.Response(
            json.dumps({'status': 'success', 'orders': order_list}),
            content_type='application/json'
        )

在這個控制器中，我們定義了一個路由 /repair/orders。當訪問這個路由時，系統會使用 ORM 查詢 repair.order 模型中的所有訂單，並將其轉換為 JSON 格式返回給客戶端。

使用 Postman 測試 GET API

現在，我們可以使用 Postman 來測試這個 API。Postman 是一個強大的 API 測試工具，允許我們發送 HTTP 請求並檢視伺服器的回應。
1. 打開 Postman 並創建新請求：
  
  打開 Postman，點擊 "New" 按鈕，選擇 "Request" 創建一個新請求。將請求命名為 "Get Repair Orders"。
2. 設置 GET 請求：
  - 方法：選擇 GET。
  - URL：輸入 http://localhost:8069/repair/orders（假設 Odoo 正在本地端口 8069 上運行）。
  - Header：設置 Content-Type 為 application/json。
  - 點擊 "Send" 發送請求。
  如果配置正確，你應該會收到一個 JSON 響應，包含所有維修訂單的詳細信息。
在後台新增資料後測試

可以通過 Odoo 的後台介面手動新增一筆維修訂單，然後使用剛剛在 Postman 中設置的 GET 請求來檢查新資料是否被正確返回。這樣可以驗證 API 是否能夠動態反映資料庫中的變更。
- 在 Odoo 後台進入 Repair 模組。
- 創建一個新的 Repair Order，填寫相關的產品、客戶和其他信息，並保存。
- 返回 Postman，重新發送 GET 請求。
- 在回應中應該能夠看到剛剛新增的維修訂單數據。

總結

通過這篇文章，我們展示了如何使用 Odoo 的 ORM 來查詢資料，並通過 GET API 返回資料以供外部系統或應用程式使用。這種方法可以輕鬆地將 Odoo 中的業務數據暴露給其他服務，並確保數據的一致性。Postman 提供了一個便捷的環境來測試和驗證 API 功能，使得開發和調試變得更加高效。這種方法非常適合需要定期查詢或整合 Odoo 資料的場景。