Package: odoo14-addon-endpoint-route-handler
Technical module that provides a base handler
for adding and removing controller routes on the fly.Can be used as a mixin or as a tool.Table of contentsUsageAs a mixinAs a toolKnown issues / RoadmapBug TrackerCreditsAuthorsContributorsMaintainersUsageAs a mixinUse standard Odoo inheritance:class MyModel(models.Model):
    _name = "my.model"
    _inherit = "endpoint.route.handler"Once you have this, eachmy.modelrecord will generate a route.
You can have a look at theendpointmodule to see a real life example.The options of the routing rules are defined by the method_default_endpoint_options.
Here’s an example from theendpointmodule:def _default_endpoint_options_handler(self):
    return {
        "klass_dotted_path": "odoo.addons.endpoint.controllers.main.EndpointController",
        "method_name": "auto_endpoint",
        "default_pargs": (self.route,),
    }As you can see, you have to pass the references to the controller class and the method to use
when the endpoint is called. And you can prepare some default arguments to pass.
In this case, the route of the current record.As a toolInitialize non stored route handlers and generate routes from them.
For instance:route_handler = self.env["endpoint.route.handler.tool"]
endpoint_handler = MyController()._my_handler
vals = {
    "name": "My custom route",
    "route": "/my/custom/route",
    "request_method": "GET",
    "auth_type": "public",
}
new_route = route_handler.new(vals)
new_route._register_controller()You can override options and define - for instance - a different controller method:options = {
    "handler": {
        "klass_dotted_path": "odoo.addons.my_module.controllers.SpecialController",
        "method_name": "my_special_handler",
    }
}
new_route._register_controller(options=options)Of course, what happens when the endpoint gets called
depends on the logic defined on the controller method.In both cases (mixin and tool) when a new route is generated or an existing one is updated,
their.http.routing_map(which holds all Odoo controllers) will be updated.You can see a real life example onshopfloor.appmodel.Known issues / Roadmapadd api docs helpersallow multiple HTTP methods on the same endpointmultiple values for route and methodskeep the same in the ui for now, later own we can imagine a multi-value selection or just add text field w/ proper validation and cleanupremove the route field in the table of endpoint_routesupport a comma separated list of routes
maybe support comma separated list of methods
use only routing.routes for generating the rule
sort and freeze its values to update the endpoint hashcatch dup route exception on the sync to detect duplicated routes
and use the endpoint_hash to retrieve the real record
(note: we could store more info in the routing information which will stay in the map)for customizing the rule behavior the endpoint the hook is to override the registry lookupmake EndpointRule class overridable on the registryNOTE in v16 we won’t care anymore about odoo controller
so the lookup of the controller can be simplified to a basic py obj that holds the routing info.Bug TrackerBugs are tracked onGitHub Issues.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomedfeedback.Do not contact contributors directly about support or help with technical issues.CreditsAuthorsCamptocampContributorsSimone Orsi <simone.orsi@camptocamp.com>MaintainersThis module is maintained by the OCA.OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.Currentmaintainer:This module is part of theOCA/web-apiproject on GitHub.You are welcome to contribute. To learn how please visithttps://odoo-community.org/page/Contribute.