odoo14-addon-endpoint-route-handler 14.0.1.0.1

Provide mixin and tool to generate custom endpoints on the fly.

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.

Important

This is an alpha version, the data model and design can change at any time without warning. Only for development or testing purpose, do not use in production. More details on development status

Table of contents

• Usage

  • As a mixin

  • As a tool

• Known issues / Roadmap

• Bug Tracker

• Credits

  • Authors

  • Contributors

  • Maintainers

Usage

As a mixin

Use standard Odoo inheritance:

class MyModel(models.Model):
    _name = "my.model"
    _inherit = "endpoint.route.handler"

Once you have this, each my.model record will generate a route. You can have a look at the endpoint module to see a real life example.

As a tool

Initialize non stored route handlers and generate routes from them. For instance:

route_handler = self.env["endpoint.route.handler"]
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._refresh_endpoint_data()  # required only for NewId records
new_route._register_controller(endpoint_handler=endpoint_handler, key="my-custom-route")

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, the ir.http.routing_map (which holds all Odoo controllers) will be updated.

You can see a real life example on shopfloor.app model.

Known issues / Roadmap

• add api docs helpers

• allow multiple HTTP methods on the same endpoint

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 smashing it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

• Camptocamp

Contributors

• Simone Orsi <[e-mail]>

Maintainers

This 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.

Current maintainer:

This module is part of the OCA/edi project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.