API Documentation

api_doc · odoo/odoo

    Repository
    odoo/odoo · module folder
    Module version
    1.0
    Category
    Hidden
    Folder size
    0.12 MB
    License
    LGPL-3
    Application
    No
    Auto-installable
    Yes
    Website
    None
    Last tracking update
    2026-08-07 06:47:03
    Authors
    Odoo S.A.
    Maintainers
    Odoo S.A.
    Committers
    Raphael Collet, Odoo Translation Bot, GitHub, Julien Castiaux, Tiffany Chang (tic), Pierre Paridans, thcl-odoo, Louis Wicket (wil), Dylan Kiss (dyki), sesn-odoo, Bastien Fafchamps (bafa), Krzysztof Magusiak (krma), Elliot ELCO, ELCO
    Odoo dependencies
    odoo/odoo:
    - web
    - base
    Python dependencies
    None
    System dependencies
    None
    Required by
    None
    Description
    Odoo Dynamic API Documentation
==============================

This module provides a dynamic documentation page for developpers at the
/doc URL. The documentation is generated using the database to list the
models and their fields and methods. It also provides a playground to run
the methods over HTTP, with examples in various programming languages.

    Code Analysis ⓘ

    Views touched (1)
    XML IDNameModelTypeStatus
    api_doc.docclient api_doc.docclient ir.ui.view qweb New
    HTTP endpoints (5)
    Route(s)HandlerAuthTypeMethodsFlags
    /doc-bearer/index.json DocController.doc_bearer_index bearer json2 ALL
    /doc-bearer/<model_name>.json DocController.doc_bearer_modec bearer json2 ALL
    /doc, /doc/<model_name>, /doc/index.html DocController.doc_client user http ALL sudo
    /doc/index.json DocController.doc_index user json2 ALL sudo
    /doc/<model_name>.json DocController.doc_model user json2 ALL sudo
    Models touched (1)

    New fields (0)

    No new fields.

    Public methods (0)

    No public methods.