OCA/rest-framework

Confirmed modules per version

Modules in the repository

• API LogOdoo 16, 17, 18
  api_log

  Stores API requests, responses and errors in the database so they can be reviewed in Odoo. Users with the API Log Access group can browse, search and filter these logs from a dedicated menu.

• API Log notificationOdoo 16, 17, 18
  api_log_mail

  When an API request fails and an exception is logged, this module can automatically create an activity and/or send an email so the right people are notified.

• Partner AuthOdoo 16, 18
  auth_partner

  This module lets you manage external partner accounts that can log in through authentication directories, with email validation, password reset, invitations and impersonation. It adds a Partner Authentication menu where you configure directories and see the…

• Base RestOdoo 12, 13, 14, 15, 16, 18
  base_rest

  This module provides the technical foundation to build and publish REST APIs for Odoo. It adds a REST API menu with a Swagger documentation page where developers can explore the available endpoints.

• Base Rest Auth Api KeyOdoo 14, 15, 16, 18
  base_rest_auth_api_key

  Adds API key security information to the automatically generated OpenAPI documentation of REST services, so developers see that an API-KEY header is required.

• Base Rest Auth JwtOdoo 14
  base_rest_auth_jwt

  Adds JWT bearer token authentication to the automatically generated API documentation of REST services, so developers can see and test secured endpoints with a JWT token.

• REST Authentication ServiceOdoo 13, 14, 15
  base_rest_auth_user_service

  Adds REST API endpoints to log in and log out of an Odoo session, so external applications can authenticate users and receive a session identifier.

• Base Rest DatamodelOdoo 12, 13, 14, 15, 16
  base_rest_datamodel

  Lets developers use DataModel objects as input and output for REST API methods, with automatic validation and OpenAPI documentation.

• Base Rest DemoOdoo 12, 13, 14, 15, 16
  base_rest_demo

  This is a demonstration module that exposes example REST API endpoints for partners and a ping service, showing how to build self-documented web services with the Base REST framework.

• Base Rest DatamodelOdoo 13, 14, 15, 16, 18
  base_rest_pydantic

  This module lets developers use Pydantic data models as input and output for REST API methods in Odoo, adding automatic validation and OpenAPI documentation. It does not add any screen or menu for end users.

• DatamodelOdoo 12, 13, 14, 15, 16
  datamodel

  This module lets developers define simple data models inside Odoo that can be converted to and from JSON. It is a technical foundation for building REST APIs and data exchanges, not a screen-based feature for end users.

• ExtendableOdoo 13, 14, 15, 16, 18
  extendable

  This module loads the Extendable library's class registry into Odoo, enabling other modules to use extendable classes. It runs automatically when Odoo starts and during HTTP requests.

• Extendable FastapiOdoo 14, 16, 18
  extendable_fastapi

  This technical module lets developers build FastAPI endpoints in Odoo using extendable classes and extendable Pydantic models, so other modules can extend request and response schemas without modifying the original code.

• Odoo FastAPIOdoo 14, 16, 17, 18, 19
  fastapi

  Lets administrators register FastAPI web services (endpoints) inside Odoo, each with its own URL path, running user, company and documentation pages, so external applications can call Odoo through a modern API.

• Fastapi Auth API KeyOdoo 17, 18
  fastapi_auth_api_key

  Lets you restrict which API keys can call each FastAPI endpoint by assigning an API key group to the endpoint.

• FastAPI Auth JWT supportOdoo 16, 18
  fastapi_auth_jwt

  Adds JWT bearer token authentication to FastAPI endpoints in Odoo, letting API developers secure routes and identify the calling user or partner from a signed token.

• FastAPI Auth JWT TestOdoo 16
  fastapi_auth_jwt_demo

  Adds a demo/test FastAPI endpoint type called "Auth JWT Demo Endpoint" to Odoo, exposing sample web routes that show who is authenticated via JWT tokens.

• Fastapi Auth PartnerOdoo 16, 18
  fastapi_auth_partner

  This module connects Odoo's partner authentication system to FastAPI endpoints, letting external applications register, log in, reset passwords, and impersonate partners via API routes.

• Fastapi CaptchaOdoo 18
  fastapi_captcha

  Protect selected FastAPI routes in Odoo with a captcha (Google reCAPTCHA, hCaptcha or Altcha). Users configure the captcha on each FastAPI endpoint and requests must include a valid captcha token.

• Fastapi Captcha Altcha BackendOdoo 18
  fastapi_captcha_altcha_backend

  Adds an Altcha captcha option to FastAPI endpoints in Odoo, so API requests can be protected by a proof-of-work challenge instead of another captcha service.

• FastAPI Encrypted ErrorsOdoo 16
  fastapi_encrypted_errors

  Adds an option on FastAPI endpoints to encrypt error details returned to API clients, and provides a wizard to decrypt those error references back into readable messages.

• fastapi_endpoint_contextOdoo 16, 18
  fastapi_endpoint_context

  Adds request context information to FastAPI endpoints so that the Odoo environment used during an API call knows which endpoint and app it belongs to.

• Fastapi LogOdoo 16, 17, 18
  fastapi_log

  Adds a 'Log requests' option on FastAPI endpoints so every incoming request, its response and any errors are stored in Odoo for debugging and monitoring.

• FastAPI Log notificationOdoo 16, 17, 18
  fastapi_log_mail

  Adds two fields to the FastAPI endpoint form so you can choose an activity type and an email template used when an exception is logged on that endpoint.

• Graphql BaseOdoo 12, 13, 14, 15, 16, 17
  graphql_base

  This module provides the technical foundation for exposing Odoo data through GraphQL endpoints. It does not add any user-facing features on its own; developers use it to build custom GraphQL APIs and a built-in GraphiQL explorer page.

• GraphQL DemoOdoo 12, 13, 14, 15, 16, 17
  graphql_demo

  Adds a sample GraphQL endpoint to Odoo so external applications can read partner data and create contacts through a standard GraphQL API. It is a demonstration module for developers, not a day-to-day business feature.

• Model SerializerOdoo 13, 14, 15
  model_serializer

  This module lets developers automatically turn Odoo models into serializable data structures, making it easier to send and receive data through APIs or integrations.

• PydanticOdoo 13, 14, 15, 16, 17, 18
  pydantic

  This module is a technical utility that helps developers convert Odoo records into Pydantic data models, ensuring correct handling of dates, empty values, and related record identifiers.

• REST LogOdoo 13, 14, 15, 16, 18
  rest_log

  Records every REST API call made to your Odoo into a searchable log, showing what was requested, the result or the error, and a link back to the related record. Old logs are cleaned up automatically.