Search 1.9 billion lines of Odoo code on GitHub

odoocodesearch

Search 1.9 billion lines of Odoo code on GitHub

demo_controller_api_http

Author:	My Company
License:	no license
Branch:	15.0
Repository:	twtrubiks/odoo-demo-addons-tutorial
Dependencies:	web
Languages:	Markdown (156, 55.9%), and Python (123, 44.1%)

<h1>odoo 15 教學 - 透過 controller http 建立簡易 REST API</h1> <ul> <li><a href="">(等待新增)Youtube Tutorial - 透過 controller http 建立簡易 REST API</a></li> </ul> 之前在 <a href="https://github.com/twtrubiks/odoo-demo-addons-tutorial/tree/14.0/demo_controller_json">odoo 14 教學 - 透過 controller 建立簡單 api</a> 這篇文章中, 有教大家簡單的透過 controller 建立 api, 今天要更進一步, 加上 <code>auth=users</code> 以及透過 <code>http</code> 打造類似 REST API 的範例. <h2>說明</h2> 首先把 addons 裝起來, <a href="https://github.com/twtrubiks/odoo-demo-addons-tutorial/blob/15.0/demo_controller_api/demo_controller_api_http/controllers/api.py">democontrollerapi_http/controllers/api.py</a> ```python from odoo import http, _ from odoo.http import request import json class DemoApiControllerHttp(http.Controller): def getresusers(self, pk=None): if pk: domain = [("id", "=", pk)] else: domain = [] <pre><code> return [ { "id": record.id, "name": record.name, "company": record.company_id.name, "phone": record.phone, "email": record.email, } for record in request.env["res.users"].sudo().search(domain) ] @http.route("/api/users/<string:pk>", methods=["GET"], type="http", auth="user", csrf=False) def api_get_res_users(self, pk=None): return json.dumps(self.get_res_users(pk)) @http.route("/api/users/", methods=["GET"], type="http", auth="user", csrf=False) def api_get_res_user(self): return json.dumps(self.get_res_users()) @http.route("/api/users/", methods=["POST"], type="http", auth="user", csrf=False) def api_post_res_user(self): param = request.params if not param["login"]: return json.dumps("login not allow empty") vals = { "name": param["name"], "phone": param["phone"], "email": param["email"], "login": param["login"], } if request.env["res.users"].sudo().search([("login", "=", param["login"])]): return json.dumps("user already exists") res_user = request.env["res.users"].sudo().create(vals) return json.dumps(self.get_res_users(res_user.id)) @http.route("/api/users/<string:pk>", methods=["PATCH"], type="http", auth="user", csrf=False) def api_patch_res_user(self, pk=None): param = request.params res_user = request.env["res.users"].sudo().search([("id", "=", pk)]) if not res_user: return json.dumps("user not exists") res_user.phone = param["phone"] return json.dumps(self.get_res_users(pk)) </code></pre> ``` 這邊和 <a href="https://github.com/twtrubiks/odoo-demo-addons-tutorial/tree/15.0/demo_controller_api/demo_controller_api_jsonrpc">democontrollerapi_jsonrpc</a> 比較不同的地方有幾個, 首先是改成了 <code>type="http"</code>, 然後加上了 <code>csrf=False</code>, 因為 odoo 定義 <code>text * if the form is accessed by an external third party (e.g. REST API endpoint, payment gateway callback) you will need to disable CSRF protection (and implement your own protection if necessary) by passing the `csrf=False` parameter to the `route` decorator. </code> 這邊主要建立了幾個 api, 分別是 <code>GET</code> <code>/api/users/</code> 取得全部 <code>res_users</code>. <code>GET</code> <code>/api/users/<string:pk></code> 取得特定 <code>res_users</code>. <code>POST</code> <code>/api/users/</code> 新增 <code>res_users</code>. <code>PATCH</code> <code>/api/users/<string:pk></code> 修改特定 <code>res_users</code> 資料. <h2>client 端</h2> <a href="https://github.com/twtrubiks/odoo-demo-addons-tutorial/blob/15.0/demo_controller_api/demo_controller_api_http/client.py">client.py</a> 端的部份就是直接執行 <code>cmd python3 client.py </code> 執行畫面, 這邊用 <code>get_users()</code> 示範, <img src="https://i.imgur.com/At4wBFy.png" alt="alt tag"> ```python import requests import json HOST = "http://0.0.0.0:8069" AUTH_URL = "{}/web/session/authenticate/".format(HOST) headers = { "Content-Type": "application/json", "Accept": "application/json", } session_data = { "jsonrpc": "2.0", "params": { "login": "admin", "password": "admin", "db": "odoo", }, } def getsessionid(): res = requests.post(AUTHURL, data=json.dumps(sessiondata), headers=headers) return res.cookies["session_id"] def getusers(): baseurl = "{}/api/users/".format(HOST) <pre><code>res = requests.get( base_url, cookies={"session_id": get_session_id()}, ) print(res.json()) </code></pre> def getuser(): baseurl = "{}/api/users/3/".format(HOST) <pre><code>res = requests.get( base_url, cookies={"session_id": get_session_id()}, ) print(res.json()) </code></pre> def adduser(): baseurl = "{}/api/users/".format(HOST) param = { "login": "testuser", "name": "testuser", "phone": "00000", "email": "xxx@test.com", } <pre><code>res = requests.post( base_url, data=param, cookies={"session_id": get_session_id()}, ) print(res.json()) </code></pre> def edituser(): baseurl = "{}/api/users/3/".format(HOST) param = { "phone": "0000000000", } <pre><code>res = requests.patch( base_url, data=param, cookies={"session_id": get_session_id()}, ) print(res.json()) </code></pre> if name == "main": getusers() # getuser() # adduser() # edituser() ``` odoo 整個流程是要先取得 <code>session_id</code>(對 <code>/web/session/authenticate/</code> 發送請求), ( 請輸入正確的 db, login, password, host ) <code>/web/session/authenticate/</code> 還是需要使用 <code>jsonrpc</code> 的方式呼叫, 原因是 <code>addons/web/controllers/main.py</code> 底下的定義就是 <code>type='json'</code>, ```python class Session(http.Controller): <pre><code>...... @http.route('/web/session/authenticate', type='json', auth="none") def authenticate(self, db, login, password, base_location=None): request.session.authenticate(db, login, password) return request.env['ir.http'].session_info() </code></pre> ``` 再去發送對應的 api ( 這邊都是使用 <code>http</code> 的方式 ).