Skip to content
Health
89/100
good
  • Security22/25
    1 minor finding
  • Activityn/a
    No commit data
  • Required by20/25
    3 modules depend on it
  • Maturity25/25
    In 11 Odoo series since 10.0

Heuristic over the facts below, not an audit · How it's computed

Security findings
Grave / minor (static analysis)
Required by
3
Modules depending on it
External deps
4 pip · 0 bin
Python packages / system binaries
License
LGPL-3
No conflicts with its dependencies
Folder size
18.37 MB
Module directory on disk
Code analysis 0 migration notes 2 models 1 view 2 HTTP endpoints

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 documentation is generated from the source code and available via a Swagger UI served by your odoo server at https://my_odoo_server/api-docs.

Dependencies

Odoo dependencies
odoo/odoo:
- web
Python dependencies
apispec, cerberus, parse-accept-language, pyquerystring
System dependencies
None
Required by
base_rest_auth_api_key, base_rest_pydantic, rest_log

Code analysis

Extracted from the source by best-effort static analysis (no code is executed); details may be incomplete.

Views touched 1

XML IDNameModelTypeStatus
openapi OpenAPI ir.ui.view qweb New

HTTP endpoints 2

Route(s)HandlerAuthTypeMethodsFlags
/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…

Loading…

Loading…

Loading…

Loading…

Loading…

Loading…

Loading…

Loading…

Loading…

Loading…