Base Rest (base_rest) - Odoo Module Metadata

TIP: You can type at any time to perform a new search.

Repository: OCA/rest-framework · module folder · Try on Runboat
Module version: 1.1.1
Category: Uncategorized
Folder size: 18.37 MB
License: LGPL-3
Application: No
Auto-installable: No
Website: https://github.com/OCA/rest-framework
Last tracking update: 2026-08-07 09:06:24
Authors: ACSONE SA/NV, Odoo Community Association (OCA)
Maintainers: ACSONE SA/NV, Odoo Community Association (OCA)
Committers: Stéphane Bidoul, Laurent Mignon (ACSONE)

Odoo dependencies

OCA/connector:

- component

odoo/odoo:

- base

- web

Python dependencies

apispec, cerberus, parse-accept-language, pyquerystring, cachetools

System dependencies

None

Required by

base_rest_auth_api_key, base_rest_pydantic, rest_log

Description

This addon is deprecated and not fully supported anymore from Odoo 16.
Please migrate to the FastAPI migration module. See
<https://github.com/OCA/rest-framework/pull/291>.

This addon provides the basis to develop high level REST APIs for Odoo.

As Odoo becomes one of the central pieces of enterprise IT systems, it
often becomes necessary to set up specialized service interfaces, so
existing systems can interact with Odoo.

While the XML-RPC interface of Odoo comes handy in such situations, it
requires a deep understanding of Odoo’s internal data model. When used
extensively, it creates a strong coupling between Odoo internals and
client systems, therefore increasing maintenance costs.

Once developed, an [OpenApi](https://spec.openapis.org/oas/v3.0.3)
documentation is generated from the source code and available via a
[Swagger UI](https://swagger.io/tools/swagger-ui/) served by your odoo
server at https://my_odoo_server/api-docs.

Code Analysis ⓘ

Views touched (1)

XML ID	Name	Model	Type	Status
`openapi`	OpenAPI	ir.ui.view	qweb	New

HTTP endpoints (2)

Route(s)	Handler	Auth	Type	Methods	Flags
`/api-docs/<path:collection>/<string:service_name>.json`	`ApiDocsController.api`	public	http	ALL
`/api-docs`, `/api-docs/index.html`	`ApiDocsController.index`	public	http	GET

Models touched (2)

New fields (0)

No new fields.

Public methods (0)

No public methods.

New fields (0)

No new fields.

Public methods (2)

build_registry(self, services_registry, states=None, exclude_addons=None)
load_services(self, module, services_registry)

Loading…

Code Analysis ⓘ

Views touched (1)

HTTP endpoints (2)

Models touched (2)

ir.rule Extends Model 0 fields 0 methods IrRule · inherits ir.rule Add authenticated_partner_id in record rule evaluation context. This come from the env context, which is populated by the base_rest service layer context provider.