odoo的api接口

快来打我* 2022-11-19 04:12 343阅读 0赞

在controllers层添加urls，可以自定义返回数据格式，json，字符串，html页面、重定向url等

[点我下载完整odoo的demo][odoo_demo]

### 对内api ###

内部访问，只能内部通过rpc来访问

import json
    from odoo import http, fields
    from odoo.http import request
    
    
    class GetPartner(http.Controller):
        @http.route('/api/partner', auth='user')
        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 = request.env['res.partner'].with_context({ 'search_default_customer': 1}).search(domain, limit=80)
            partners = []
            for res in partner:
                partners.append({ 
                    'id': res.id,
                    'text': res.name,
                })
            return json.dumps(partners)

比如js中使用rpc访问：

// select2控件加载客户数据
    $('#partner_ids').select2({ 
        multiple: true,
        ajax: { 
            url: '/api/partner',
            contentType: "application/json; charset=utf-8",
            dataType: 'json',
            data: function (str) { 
                return { 
                    keywords: str
                }
            },
            results: function (data) { 
                return { 
                    results: data
                };
            },
            cache: true
        }
    });

### 外部api ###

外部访问需要加dmz前缀：

# -*- coding: utf-8 -*-
    import json
    import jinja2
    import werkzeug
    import sys
    import os
    import logging
    
    from odoo import http
    from odoo.http import request, JsonRequest, Response
    from odoo.tools import ustr, date_utils
    
    if hasattr(sys, 'frozen'):
        # 加载html目录，使用jinja2渲染模板
        path = os.path.realpath(os.path.join(os.path.dirname(__file__), '..', 'views'))
        loader = jinja2.FileSystemLoader(path)
    else:
        loader = jinja2.PackageLoader('odoo.addons.my_first_app', 'views')
    
    env = jinja2.Environment(loader=loader, autoescape=True)
    env.filters['json'] = json.dumps
    _logger = logging.getLogger(__name__)
    
    
    def _json_response(self, result=None, error=None):
        # 自定义odoo接口返回数据格式，获取到参数my_json就直接返回json数据，否则就返回默认数据格式
        # 默认数据格式
        ''' { 'jsonrpc': '2.0', 'id': 12, 'data': {} } '''
        if self.endpoint and self.endpoint.routing.get('my_json'):
            response = { }
            if error is not None:
                response['error'] = error
            if result is not None:
                response = result
        else:
            # odoo返回的默认数据格式
            response = { 
                'jsonrpc': '2.0',
                'id': self.jsonrequest.get('id')
            }
            if error is not None:
                response['error'] = error
            if result is not None:
                response['result'] = result
    
        mime = 'application/json'
        body = json.dumps(response, default=date_utils.json_default)
    
        return Response(
            body, status=error and error.pop('http_status', 200) or 200,
            headers=[('Content-Type', mime), ('Content-Length', len(body))]
        )
    
    
    # 重写JsonRequest中的_json_response方法
    setattr(JsonRequest, '_json_response', _json_response)
    
    
    class MyAPI(http.Controller):
        # 对外api
    
        def valid_response(self, data, message='', fmt='json'):
            # 返回json数据
            if fmt == 'str':
                return werkzeug.wrappers.Response(response=message)
            res = { 'error': 0, 'message': message}
            res['data'] = data
            return werkzeug.wrappers.Response(
                content_type="application/json; charset=utf-8",
                response=json.dumps(res),
            )
    
        def invalid_response(self, message, error=1, fmt='json'):
            # 返回错误提示
            if fmt == 'str':
                return werkzeug.wrappers.Response(response=message)
            res = { 'error': error, 'message': ''}
            res['message'] = message
    
            return werkzeug.wrappers.Response(
                content_type="application/json; charset=utf-8",
                response=json.dumps(res),
            )
    
        def invalid_response_template(self, message):
            # 返回错误页面
            return env.get_template('error.html').render({ 'message': message})
    
        def get_base_url(self):
            # 可以在系统参数中定义一个主url
            return request.env['ir.config_parameter'].sudo().get_param('web.url')
    
        @http.route('/dmz/hello_world', type='http', auth='public', website=True, sitemap=False)
        def helloworld(self, *args, **kw):
            # 返回格式1：返回jinjia2渲染的页面
            # return self.invalid_response_template('参数有误')
            # 返回格式2：重定向url
            url = '/dmz/redirect_url'
            return werkzeug.utils.redirect(url)
            # 返回格式3： json格式
            # data = {'python': 'hello world'}
            # return self.valid_response(data)
    
        @http.route('/dmz/redirect_url', type='http', auth='public',csrf=False)
        def redirect_url(self, *args, **kw):
            return { 'code': 200, 'msg': '111'}
    
        @http.route('/dmz/defaultjson', type='json', auth='public', methods=['POST'], csrf=False)
        def default_json(self, *args, **kw):
    
            # 返回odoo默认的Json格式数据
            return { 'code': 200, 'msg': '默认json格式'}
    
        @http.route('/dmz/newjson', type='json', auth='public', methods=['POST'], csrf=False, my_json=True)
        def new_json(self, *args, **kw):
    
            # 返回自定义的Json格式数据
            return { 'code': 200, 'msg': '自定义json格式'}

在浏览器上输入127.0.0.1:8069/dmz/hello\_world即可获取数据。

type='http’表示返回字符串

type='json’表示返回json

测试：

import json
    
    import requests
    header = { 'Content-Type': 'application/json'}
    # odoo默认格式
    url='http://127.0.0.1:8199/dmz/defaultjson'
    response = requests.post(url,  data=json.dumps({ 'code':200}), headers=header)
    print('odoo默认格式 ', response.content.decode('utf-8'))
    
    # 自定义返回的json格式
    url='http://127.0.0.1:8199/dmz/newjson'
    new_response = requests.post(url,  data=json.dumps({ 'code':200}), headers=header)
    print('自定义返回的json格式', new_response.content.decode('utf-8'))

![在这里插入图片描述][20210414170801986.png_pic_center]

## 后记 ##

【后记】为了让大家能够轻松学编程，我创建了一个公众号【轻松学编程】，里面有让你快速学会编程的文章，当然也有一些干货提高你的编程水平，也有一些编程项目适合做一些课程设计等课题。

也可加我微信【1257309054】，拉你进群，大家一起交流学习。  
如果文章对您有帮助，请我喝杯咖啡吧！

公众号

![公众号][20200317124808234.jpg]

关注我，我们一起成长~~

[odoo_demo]: https://download.csdn.net/download/lm_is_dc/16818292
[20210414170801986.png_pic_center]: /images/20221022/a48996dfff1a4dd1a2e0d0b222ea3aab.png
[20200317124808234.jpg]: /images/20221022/9901b31bf2874e598e96b0eb87549174.png