Maintainers
+Maintainers
This module is maintained by the OCA.
@@ -1837,6 +1837,5 @@
+
-
-
Odoo FastAPI
- - -
-
Odoo FastAPI
-
This addon provides the basis to smoothly integrate the FastAPI framework into Odoo.
This integration allows you to use all the goodies from FastAPI to build custom @@ -458,9 +453,9 @@
Odoo FastAPI
-
Usage
+Usage
-What’s building an API with fas
What’s building an API with fastapi?
+What’s building an API with fastapi?
FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.7+ based on standard Python type hints. This addons let’s you keep advantage of the fastapi framework and use it with Odoo.
@@ -510,9 +505,9 @@What’s building an API with fas
Then, you need to declare your app by defining a model that inherits from
‘fastapi.endpoint’ and add your app name into the app field. For example:
-from odoo import fields, models
+from odoo import fields, models
-class FastapiEndpoint(models.Model):
+class FastapiEndpoint(models.Model):
_inherit = "fastapi.endpoint"
@@ -535,10 +530,10 @@ What’s building an API with fas
Now, you can create your first router. For that, you need to define a global
variable into your fastapi_endpoint module called for example ‘demo_api_router’
-from fastapi import APIRouter
-from odoo import fields, models
+from fastapi import APIRouter
+from odoo import fields, models
-class FastapiEndpoint(models.Model):
+class FastapiEndpoint(models.Model):
_inherit = "fastapi.endpoint"
@@ -552,10 +547,10 @@ What’s building an API with fas
To make your router available to your app, you need to add it to the list of routers
returned by the _get_fastapi_routers method of your fastapi_endpoint model.
-from fastapi import APIRouter
-from odoo import api, fields, models
+from fastapi import APIRouter
+from odoo import api, fields, models
-class FastapiEndpoint(models.Model):
+class FastapiEndpoint(models.Model):
_inherit = "fastapi.endpoint"
@@ -563,7 +558,7 @@ What’s building an API with fas
selection_add=[("demo", "Demo Endpoint")], ondelete={"demo": "cascade"}
)
- def _get_fastapi_routers(self):
+ def _get_fastapi_routers(self):
if self.app == "demo":
return [demo_api_router]
return super()._get_fastapi_routers()
@@ -574,17 +569,17 @@ What’s building an API with fas
Now, you can start adding routes to your router. For example, let’s add a route
that returns a list of partners.
-from typing import Annotated
+from typing import Annotated
-from fastapi import APIRouter
-from pydantic import BaseModel
+from fastapi import APIRouter
+from pydantic import BaseModel
-from odoo import api, fields, models
-from odoo.api import Environment
+from odoo import api, fields, models
+from odoo.api import Environment
-from odoo.addons.fastapi.dependencies import odoo_env
+from odoo.addons.fastapi.dependencies import odoo_env
-class FastapiEndpoint(models.Model):
+class FastapiEndpoint(models.Model):
_inherit = "fastapi.endpoint"
@@ -592,7 +587,7 @@ What’s building an API with fas
selection_add=[("demo", "Demo Endpoint")], ondelete={"demo": "cascade"}
)
- def _get_fastapi_routers(self):
+ def _get_fastapi_routers(self):
if self.app == "demo":
return [demo_api_router]
return super()._get_fastapi_routers()
@@ -600,12 +595,12 @@ What’s building an API with fas
# create a router
demo_api_router = APIRouter()
-class PartnerInfo(BaseModel):
+class PartnerInfo(BaseModel):
name: str
email: str
@demo_api_router.get("/partners", response_model=list[PartnerInfo])
-def get_partners(env: Annotated[Environment, Depends(odoo_env)]) -> list[PartnerInfo]:
+def get_partners(env: Annotated[Environment, Depends(odoo_env)]) -> list[PartnerInfo]:
return [
PartnerInfo(name=partner.name, email=partner.email)
for partner in env["res.partner"].search([])
@@ -614,6 +609,11 @@ What’s building an API with fas
Now, you can start your Odoo server, install your addon and create a new endpoint
instance for your app. Once it’s done click on the docs url to access the
interactive documentation of your app.
+Note: FastAPI automatically exposes three services to easily interact with
+the APIs and their structure (Swagger, Redoc, OpenAPI).
+When exposing your Odoo instance to the open internet you might want to disable
+these services. To do so toggle the “Expose FastAPI docs” checkbox in the FastAPI
+Endpoint form view.
Before trying to test your app, you need to define on the endpoint instance the
user that will be used to run the app. You can do it by setting the ‘user_id’
field. This information is the most important one because it’s the basis for
@@ -664,19 +664,19 @@
What’s building an API with fas
What’s building an API with fas
Now, you can create your first router. For that, you need to define a global
variable into your fastapi_endpoint module called for example ‘demo_api_router’
-from fastapi import APIRouter
-from odoo import fields, models
+from fastapi import APIRouter
+from odoo import fields, models
-class FastapiEndpoint(models.Model):
+class FastapiEndpoint(models.Model):
_inherit = "fastapi.endpoint"
@@ -552,10 +547,10 @@ What’s building an API with fas
To make your router available to your app, you need to add it to the list of routers
returned by the _get_fastapi_routers method of your fastapi_endpoint model.
-from fastapi import APIRouter
-from odoo import api, fields, models
+from fastapi import APIRouter
+from odoo import api, fields, models
-class FastapiEndpoint(models.Model):
+class FastapiEndpoint(models.Model):
_inherit = "fastapi.endpoint"
@@ -563,7 +558,7 @@ What’s building an API with fas
selection_add=[("demo", "Demo Endpoint")], ondelete={"demo": "cascade"}
)
- def _get_fastapi_routers(self):
+ def _get_fastapi_routers(self):
if self.app == "demo":
return [demo_api_router]
return super()._get_fastapi_routers()
@@ -574,17 +569,17 @@ What’s building an API with fas
Now, you can start adding routes to your router. For example, let’s add a route
that returns a list of partners.
-from typing import Annotated
+from typing import Annotated
-from fastapi import APIRouter
-from pydantic import BaseModel
+from fastapi import APIRouter
+from pydantic import BaseModel
-from odoo import api, fields, models
-from odoo.api import Environment
+from odoo import api, fields, models
+from odoo.api import Environment
-from odoo.addons.fastapi.dependencies import odoo_env
+from odoo.addons.fastapi.dependencies import odoo_env
-class FastapiEndpoint(models.Model):
+class FastapiEndpoint(models.Model):
_inherit = "fastapi.endpoint"
@@ -592,7 +587,7 @@ What’s building an API with fas
selection_add=[("demo", "Demo Endpoint")], ondelete={"demo": "cascade"}
)
- def _get_fastapi_routers(self):
+ def _get_fastapi_routers(self):
if self.app == "demo":
return [demo_api_router]
return super()._get_fastapi_routers()
@@ -600,12 +595,12 @@ What’s building an API with fas
# create a router
demo_api_router = APIRouter()
-class PartnerInfo(BaseModel):
+class PartnerInfo(BaseModel):
name: str
email: str
@demo_api_router.get("/partners", response_model=list[PartnerInfo])
-def get_partners(env: Annotated[Environment, Depends(odoo_env)]) -> list[PartnerInfo]:
+def get_partners(env: Annotated[Environment, Depends(odoo_env)]) -> list[PartnerInfo]:
return [
PartnerInfo(name=partner.name, email=partner.email)
for partner in env["res.partner"].search([])
@@ -614,6 +609,11 @@ What’s building an API with fas
Now, you can start your Odoo server, install your addon and create a new endpoint
instance for your app. Once it’s done click on the docs url to access the
interactive documentation of your app.
+Note: FastAPI automatically exposes three services to easily interact with
+the APIs and their structure (Swagger, Redoc, OpenAPI).
+When exposing your Odoo instance to the open internet you might want to disable
+these services. To do so toggle the “Expose FastAPI docs” checkbox in the FastAPI
+Endpoint form view.
Before trying to test your app, you need to define on the endpoint instance the
user that will be used to run the app. You can do it by setting the ‘user_id’
field. This information is the most important one because it’s the basis for
@@ -664,19 +664,19 @@
What’s building an API with fas
What’s building an API with fas
To make your router available to your app, you need to add it to the list of routers
returned by the _get_fastapi_routers method of your fastapi_endpoint model.
-from fastapi import APIRouter
-from odoo import api, fields, models
+from fastapi import APIRouter
+from odoo import api, fields, models
-class FastapiEndpoint(models.Model):
+class FastapiEndpoint(models.Model):
_inherit = "fastapi.endpoint"
@@ -563,7 +558,7 @@ What’s building an API with fas
selection_add=[("demo", "Demo Endpoint")], ondelete={"demo": "cascade"}
)
- def _get_fastapi_routers(self):
+ def _get_fastapi_routers(self):
if self.app == "demo":
return [demo_api_router]
return super()._get_fastapi_routers()
@@ -574,17 +569,17 @@ What’s building an API with fas
Now, you can start adding routes to your router. For example, let’s add a route
that returns a list of partners.
-from typing import Annotated
+from typing import Annotated
-from fastapi import APIRouter
-from pydantic import BaseModel
+from fastapi import APIRouter
+from pydantic import BaseModel
-from odoo import api, fields, models
-from odoo.api import Environment
+from odoo import api, fields, models
+from odoo.api import Environment
-from odoo.addons.fastapi.dependencies import odoo_env
+from odoo.addons.fastapi.dependencies import odoo_env
-class FastapiEndpoint(models.Model):
+class FastapiEndpoint(models.Model):
_inherit = "fastapi.endpoint"
@@ -592,7 +587,7 @@ What’s building an API with fas
selection_add=[("demo", "Demo Endpoint")], ondelete={"demo": "cascade"}
)
- def _get_fastapi_routers(self):
+ def _get_fastapi_routers(self):
if self.app == "demo":
return [demo_api_router]
return super()._get_fastapi_routers()
@@ -600,12 +595,12 @@ What’s building an API with fas
# create a router
demo_api_router = APIRouter()
-class PartnerInfo(BaseModel):
+class PartnerInfo(BaseModel):
name: str
email: str
@demo_api_router.get("/partners", response_model=list[PartnerInfo])
-def get_partners(env: Annotated[Environment, Depends(odoo_env)]) -> list[PartnerInfo]:
+def get_partners(env: Annotated[Environment, Depends(odoo_env)]) -> list[PartnerInfo]:
return [
PartnerInfo(name=partner.name, email=partner.email)
for partner in env["res.partner"].search([])
@@ -614,6 +609,11 @@ What’s building an API with fas
Now, you can start your Odoo server, install your addon and create a new endpoint
instance for your app. Once it’s done click on the docs url to access the
interactive documentation of your app.
+Note: FastAPI automatically exposes three services to easily interact with
+the APIs and their structure (Swagger, Redoc, OpenAPI).
+When exposing your Odoo instance to the open internet you might want to disable
+these services. To do so toggle the “Expose FastAPI docs” checkbox in the FastAPI
+Endpoint form view.
Before trying to test your app, you need to define on the endpoint instance the
user that will be used to run the app. You can do it by setting the ‘user_id’
field. This information is the most important one because it’s the basis for
@@ -664,19 +664,19 @@
What’s building an API with fas
What’s building an API with fas
selection_add=[("demo", "Demo Endpoint")], ondelete={"demo": "cascade"} ) - def _get_fastapi_routers(self): + def _get_fastapi_routers(self): if self.app == "demo": return [demo_api_router] return super()._get_fastapi_routers() @@ -574,17 +569,17 @@What’s building an API with fas
Now, you can start adding routes to your router. For example, let’s add a route
that returns a list of partners.
-from typing import Annotated
+from typing import Annotated
-from fastapi import APIRouter
-from pydantic import BaseModel
+from fastapi import APIRouter
+from pydantic import BaseModel
-from odoo import api, fields, models
-from odoo.api import Environment
+from odoo import api, fields, models
+from odoo.api import Environment
-from odoo.addons.fastapi.dependencies import odoo_env
+from odoo.addons.fastapi.dependencies import odoo_env
-class FastapiEndpoint(models.Model):
+class FastapiEndpoint(models.Model):
_inherit = "fastapi.endpoint"
@@ -592,7 +587,7 @@ What’s building an API with fas
selection_add=[("demo", "Demo Endpoint")], ondelete={"demo": "cascade"}
)
- def _get_fastapi_routers(self):
+ def _get_fastapi_routers(self):
if self.app == "demo":
return [demo_api_router]
return super()._get_fastapi_routers()
@@ -600,12 +595,12 @@ What’s building an API with fas
# create a router
demo_api_router = APIRouter()
-class PartnerInfo(BaseModel):
+class PartnerInfo(BaseModel):
name: str
email: str
@demo_api_router.get("/partners", response_model=list[PartnerInfo])
-def get_partners(env: Annotated[Environment, Depends(odoo_env)]) -> list[PartnerInfo]:
+def get_partners(env: Annotated[Environment, Depends(odoo_env)]) -> list[PartnerInfo]:
return [
PartnerInfo(name=partner.name, email=partner.email)
for partner in env["res.partner"].search([])
@@ -614,6 +609,11 @@ What’s building an API with fas
Now, you can start your Odoo server, install your addon and create a new endpoint
instance for your app. Once it’s done click on the docs url to access the
interactive documentation of your app.
+Note: FastAPI automatically exposes three services to easily interact with
+the APIs and their structure (Swagger, Redoc, OpenAPI).
+When exposing your Odoo instance to the open internet you might want to disable
+these services. To do so toggle the “Expose FastAPI docs” checkbox in the FastAPI
+Endpoint form view.
Before trying to test your app, you need to define on the endpoint instance the
user that will be used to run the app. You can do it by setting the ‘user_id’
field. This information is the most important one because it’s the basis for
@@ -664,19 +664,19 @@
What’s building an API with fas
What’s building an API with fas
selection_add=[("demo", "Demo Endpoint")], ondelete={"demo": "cascade"} ) - def _get_fastapi_routers(self): + def _get_fastapi_routers(self): if self.app == "demo": return [demo_api_router] return super()._get_fastapi_routers() @@ -600,12 +595,12 @@What’s building an API with fas
# create a router demo_api_router = APIRouter() -class PartnerInfo(BaseModel): +class PartnerInfo(BaseModel): name: str email: str @demo_api_router.get("/partners", response_model=list[PartnerInfo]) -def get_partners(env: Annotated[Environment, Depends(odoo_env)]) -> list[PartnerInfo]: +def get_partners(env: Annotated[Environment, Depends(odoo_env)]) -> list[PartnerInfo]: return [ PartnerInfo(name=partner.name, email=partner.email) for partner in env["res.partner"].search([]) @@ -614,6 +609,11 @@What’s building an API with fas
Now, you can start your Odoo server, install your addon and create a new endpoint
instance for your app. Once it’s done click on the docs url to access the
interactive documentation of your app.
+Note: FastAPI automatically exposes three services to easily interact with
+the APIs and their structure (Swagger, Redoc, OpenAPI).
+When exposing your Odoo instance to the open internet you might want to disable
+these services. To do so toggle the “Expose FastAPI docs” checkbox in the FastAPI
+Endpoint form view.
Before trying to test your app, you need to define on the endpoint instance the
user that will be used to run the app. You can do it by setting the ‘user_id’
field. This information is the most important one because it’s the basis for
@@ -664,19 +664,19 @@
What’s building an API with fas
-
Dealing with the odoo environment
+Dealing with the odoo environment
The ‘odoo.addons.fastapi.dependencies’ module provides a set of functions that you can use to inject reusable dependencies into your routes. For example, the ‘odoo_env’ function returns the current odoo environment. You can use it to access the odoo models and the database from your route handlers.
-from typing import Annotated +from typing import Annotated -from odoo.api import Environment -from odoo.addons.fastapi.dependencies import odoo_env +from odoo.api import Environment +from odoo.addons.fastapi.dependencies import odoo_env @demo_api_router.get("/partners", response_model=list[PartnerInfo]) -def get_partners(env: Annotated[Environment, Depends(odoo_env)]) -> list[PartnerInfo]: +def get_partners(env: Annotated[Environment, Depends(odoo_env)]) -> list[PartnerInfo]: return [ PartnerInfo(name=partner.name, email=partner.email) for partner in env["res.partner"].search([]) @@ -712,7 +712,7 @@Dealing with the odoo environment
-The dependency injection mechanis
that the method depends of two parameters: ‘endpoint_id’ and ‘env’. Each
of these parameters are dependencies themselves.
The dependency injection mechanism
+The dependency injection mechanism
The ‘odoo_env’ dependency relies on a simple implementation that retrieves the current odoo environment from ContextVar variable initialized at the start of the request processing by the specific request dispatcher processing the @@ -724,7 +724,7 @@
The dependency injection mechanis
that the method depends of two parameters: ‘endpoint_id’ and ‘env’. Each
of these parameters are dependencies themselves.
-def fastapi_endpoint_id() -> int:
+def fastapi_endpoint_id() -> int:
"""This method is overriden by default to make the fastapi.endpoint record
available for your endpoint method. To get the fastapi.endpoint record
in your method, you just need to add a dependency on the fastapi_endpoint method
@@ -732,7 +732,7 @@ The dependency injection mechanis
"""
-def fastapi_endpoint(
+def fastapi_endpoint(
_id: Annotated[int, Depends(fastapi_endpoint_id)],
env: Annotated[Environment, Depends(odoo_env)],
) -> "FastapiEndpoint":
@@ -748,7 +748,7 @@ The dependency injection mechanis
registering a specific method that returns the id of the current fastapi endpoint
model instance for the original method.
-def _get_app(self) -> FastAPI:
+def _get_app(self) -> FastAPI:
app = FastAPI(**self._prepare_fastapi_endpoint_params())
for router in self._get_fastapi_routers():
app.include_router(prefix=self.root_path, router=router)
@@ -762,18 +762,18 @@ The dependency injection mechanis
endpoint configuration.
The dependency injection mechanis """
-def fastapi_endpoint( +def fastapi_endpoint( _id: Annotated[int, Depends(fastapi_endpoint_id)], env: Annotated[Environment, Depends(odoo_env)], ) -> "FastapiEndpoint": @@ -748,7 +748,7 @@The dependency injection mechanis
registering a specific method that returns the id of the current fastapi endpoint
model instance for the original method.
-def _get_app(self) -> FastAPI:
+def _get_app(self) -> FastAPI:
app = FastAPI(**self._prepare_fastapi_endpoint_params())
for router in self._get_fastapi_routers():
app.include_router(prefix=self.root_path, router=router)
@@ -762,18 +762,18 @@ The dependency injection mechanis
endpoint configuration.
The dependency injection mechanis endpoint configuration.
-
The authentication mechanism
+The authentication mechanism
To make our app not tightly coupled with a specific authentication mechanism, we will use the ‘authenticated_partner’ dependency. As for the ‘fastapi_endpoint’ this dependency depends on an abstract dependency.
When you define a route handler, you can inject the ‘authenticated_partner’ dependency as a parameter of your route handler.
-from odoo.addons.base.models.res_partner import Partner +from odoo.addons.base.models.res_partner import Partner @demo_api_router.get("/partners", response_model=list[PartnerInfo]) -def get_partners( +def get_partners( env: Annotated[Environment, Depends(odoo_env)], partner: Annotated[Partner, Depends(authenticated_partner)] ) -> list[PartnerInfo]: return [ @@ -789,7 +789,7 @@The authentication mechanism< ‘odoo.addons.fastapi.dependencies’ module and relies on functionalities provided by the ‘fastapi.security’ module.
-def authenticated_partner( +def authenticated_partner( env: Annotated[Environment, Depends(odoo_env)], security: Annotated[HTTPBasicCredentials, Depends(HTTPBasic())], ) -> "res.partner": @@ -827,9 +827,9 @@The authentication mechanism< authentication by using an api key or via basic auth. Since basic auth is already implemented, we will only implement the api key authentication mechanism.
-from fastapi.security import APIKeyHeader +from fastapi.security import APIKeyHeader -def api_key_based_authenticated_partner_impl( +def api_key_based_authenticated_partner_impl( api_key: Annotated[str, Depends( APIKeyHeader( name="api-key", @@ -854,9 +854,9 @@The authentication mechanism< can allows the user to select one of these authentication mechanisms by adding a selection field on the fastapi endpoint model.
-from odoo import fields, models +from odoo import fields, models -class FastapiEndpoint(models.Model): +class FastapiEndpoint(models.Model): _inherit = "fastapi.endpoint" @@ -879,8 +879,8 @@The authentication mechanism< provide the right implementation of the ‘authenticated_partner’ dependency when the app is instantiated.
-from odoo.addons.fastapi.dependencies import authenticated_partner -class FastapiEndpoint(models.Model): +from odoo.addons.fastapi.dependencies import authenticated_partner +class FastapiEndpoint(models.Model): _inherit = "fastapi.endpoint" @@ -892,7 +892,7 @@The authentication mechanism<
string="Authenciation method", ) - def _get_app(self) -> FastAPI: + def _get_app(self) -> FastAPI: app = super()._get_app() if self.app == "demo": # Here we add the overrides to the authenticated_partner_impl method @@ -923,7 +923,7 @@The authentication mechanism<