Maintainers
+Maintainers
This module is maintained by the OCA.
@@ -772,6 +767,5 @@
+
-
-
-Base Rest
- - -
-
Base Rest
-
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.
@@ -414,7 +409,7 @@Base Rest
-
Configuration
+Configuration
If an error occurs when calling a method of a service (ie missing parameter, ..) the system returns only a general description of the problem without details. This is done on purpose to ensure maximum @@ -436,7 +431,7 @@
Configuration
mode in production.
-
Usage
+Usage
To add your own REST service you must provides at least 2 classes.
- A Component providing the business logic of your service, @@ -466,10 +461,10 @@
Usage
<string:_service_name>/<int:_id>/<string:method_name>-from odoo.addons.component.core import Component +from odoo.addons.component.core import Component -class PingService(Component): +class PingService(Component): _inherit = 'base.rest.service' _name = 'ping.service' _usage = 'ping' @@ -477,37 +472,37 @@Usage
# The following method are 'public' and can be called from the controller. - def get(self, _id, message): + def get(self, _id, message): return { 'response': 'Get called with message ' + message} - def search(self, message): + def search(self, message): return { 'response': 'Search called search with message ' + message} - def update(self, _id, message): + def update(self, _id, message): return {'response': 'PUT called with message ' + message} # pylint:disable=method-required-super - def create(self, **params): + def create(self, **params): return {'response': 'POST called with message ' + params['message']} - def delete(self, _id): + def delete(self, _id): return {'response': 'DELETE called with id %s ' % _id} # Validator - def _validator_search(self): + def _validator_search(self): return {'message': {'type': 'string'}} # Validator - def _validator_get(self): + def _validator_get(self): # no parameters by default return {} - def _validator_update(self): + def _validator_update(self): return {'message': {'type': 'string'}} - def _validator_create(self): + def _validator_create(self): return {'message': {'type': 'string'}}
Once you have implemented your services (ping, …), you must tell to @@ -515,9 +510,9 @@
Usage
implementing a controller that inherits from odoo.addons.base_rest.controllers.main.RestController-from odoo.addons.base_rest.controllers import main +from odoo.addons.base_rest.controllers import main -class MyRestController(main.RestController): +class MyRestController(main.RestController): _root_path = '/my_services_api/' _collection_name = my_module.services@@ -533,7 +528,7 @@
Usage
ROOT_PATH + '<string:_service_name>/<int:_id>', ROOT_PATH + '<string:_service_name>/<int:_id>/get' ], methods=['GET'], auth="user", csrf=False) -def get(self, _service_name, _id=None, **params): +def get(self, _service_name, _id=None, **params): method_name = 'get' if _id else 'search' return self._process_method(_service_name, method_name, _id, params) @@ -543,7 +538,7 @@Usage
ROOT_PATH + '<string:_service_name>/<int:_id>', ROOT_PATH + '<string:_service_name>/<int:_id>/<string:method_name>' ], methods=['POST'], auth="user", csrf=False) -def modify(self, _service_name, _id=None, method_name=None, **params): +def modify(self, _service_name, _id=None, method_name=None, **params): if not method_name: method_name = 'update' if _id else 'create' if method_name == 'get': @@ -555,13 +550,13 @@Usage
@route([ ROOT_PATH + '<string:_service_name>/<int:_id>', ], methods=['PUT'], auth="user", csrf=False) -def update(self, _service_name, _id, **params): +def update(self, _service_name, _id, **params): return self._process_method(_service_name, 'update', _id, params) @route([ ROOT_PATH + '<string:_service_name>/<int:_id>', ], methods=['DELETE'], auth="user", csrf=False) -def delete(self, _service_name, _id): +def delete(self, _service_name, _id): return self._process_method(_service_name, 'delete', _id)As result an HTTP GET call to ‘http://my_odoo/my_services_api/ping’ will @@ -583,7 +578,7 @@
Usage
the use of a python decorator to explicitly mark a method as being available via the REST API: odoo.addons.base_rest.restapi.method.-class PartnerNewApiService(Component): +class PartnerNewApiService(Component): _inherit = "base.rest.service" _name = "partner.new_api.service" _usage = "partner" @@ -598,10 +593,10 @@@@ -620,28 +615,28 @@Usage
output_param=restapi.CerberusValidator("_get_partner_schema"), auth="public", ) - def get(self, _id): + def get(self, _id): return {"name": self.env["res.partner"].browse(_id).name} - def _get_partner_schema(self): + def _get_partner_schema(self): return { "name": {"type": "string", "required": True} } @@ -611,7 +606,7 @@Usage
output_param=restapi.CerberusListValidator("_get_partner_schema"), auth="public", ) - def list(self): + def list(self): partners = self.env["res.partner"].search([]) return [{"name": p.name} for p in partners]
Usage
For example, base_rest_datamodel allows you to use Datamodel object instance into your services.-from marshmallow import fields +from marshmallow import fields -from odoo.addons.base_rest import restapi -from odoo.addons.component.core import Component -from odoo.addons.datamodel.core import Datamodel +from odoo.addons.base_rest import restapi +from odoo.addons.component.core import Component +from odoo.addons.datamodel.core import Datamodel -class PartnerSearchParam(Datamodel): +class PartnerSearchParam(Datamodel): _name = "partner.search.param" id = fields.Integer(required=False, allow_none=False) name = fields.String(required=False, allow_none=False) -class PartnerShortInfo(Datamodel): +class PartnerShortInfo(Datamodel): _name = "partner.short.info" id = fields.Integer(required=True, allow_none=False) name = fields.String(required=True, allow_none=False) -class PartnerNewApiService(Component): +class PartnerNewApiService(Component): _inherit = "base.rest.service" _name = "partner.new_api.service" _usage = "partner" @@ -657,7 +652,7 @@Usage
output_param=restapi.Datamodel("partner.short.info", is_list=True), auth="public", ) - def search(self, partner_search_param): + def search(self, partner_search_param): """ Search for partners :param partner_search_param: An instance of partner.search.param @@ -683,7 +678,7 @@Usage
evaluation context.
-
Known issues / Roadmap
+Known issues / Roadmap
The
roadmap
and known
@@ -691,9 +686,9 @@ Known issues / Roadmap
can be found on GitHub.
-
Changelog
+Changelog
-
16.0.1.0.2 (2023-10-07)
+16.0.1.0.2 (2023-10-07)
Features
- Add support for oauth2 security scheme in the Swagger UI. If your
@@ -707,7 +702,7 @@
16.0.1.0.2 (2023-10-07)
-
12.0.2.0.1
+12.0.2.0.1
- validator_…() methods can now return a cerberus Validator
object instead of a schema dictionnary, for additional flexibility
@@ -715,20 +710,20 @@
12.0.2.0.1
-
12.0.1.0.1
+12.0.1.0.1
- Fix issue when rendering the jsonapi documentation if no documentation is provided on a method part of the REST api.
-
12.0.1.0.0
+12.0.1.0.0
First official version. The addon has been incubated into the Shopinvader repository from @@ -736,7 +731,7 @@
12.0.1.0.0
-
Bug Tracker
+Bug Tracker
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed @@ -744,22 +739,22 @@
Bug Tracker
Do not contact contributors directly about support or help with technical issues.
-
Credits
+Credits
-
Contributors
+Contributors
- Laurent Mignon <laurent.mignon@acsone.eu>
- Sébastien Beau <sebastien.beau@akretion.com>