Base Rest
base_rest · OCA/rest-framework
-
Security22/251 minor finding
-
Activityn/aNo commit data
-
Required by20/253 modules depend on it
-
Maturity25/25In 11 Odoo series since 10.0
Heuristic over the facts below, not an audit · How it's computed
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
- 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 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
No new fields.
Public methods (0)No public methods.
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…