odoo14-addon-endpoint-route-handler

====================== Endpoint route handler

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:441f31f154913353d8a88d37067308bd8f9ec293c07b4ced67c52fd3cf82b5e6 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png :target: https://odoo-community.org/page/development-status :alt: Beta .. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html :alt: License: LGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb--api-lightgray.png?logo=github :target: https://github.com/OCA/web-api/tree/14.0/endpoint_route_handler :alt: OCA/web-api .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png :target: https://translation.odoo-community.org/projects/web-api-14-0/web-api-14-0-endpoint_route_handler :alt: Translate me on Weblate .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png :target: https://runboat.odoo-community.org/builds?repo=OCA/web-api&target_branch=14.0 :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

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 contents

.. contents:: :local:

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.

The options of the routing rules are defined by the method `_default_endpoint_options`.
Here's an example from the `endpoint` module::

    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 tool
~~~~~~~~~

Initialize 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,
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
* multiple values for route and methods

    keep 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 cleanup

    remove the route field in the table of endpoint_route

    support 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 hash

    catch 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 lookup

    make EndpointRule class overridable on the registry

NOTE 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 Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/web-api/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
`feedback <https://github.com/OCA/web-api/issues/new?body=module:%20endpoint_route_handler%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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.

.. |maintainer-simahawk| image:: https://github.com/simahawk.png?size=40px
    :target: https://github.com/simahawk
    :alt: simahawk

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-simahawk| 

This module is part of the `OCA/web-api <https://github.com/OCA/web-api/tree/14.0/endpoint_route_handler>`_ project on GitHub.

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