跳转到主要内容

base_rest的Pydantic绑定

项目描述

Beta License: LGPL-3 OCA/rest-framework Translate me on Weblate Try me on Runbot

此插件允许您在REST API方法中使用Pydantic对象作为参数和/或响应。

目录

用法

要使用Pydantic实例作为REST服务端点的请求和/或响应,您必须

  • 定义您的Pydantic类;

  • odoo.addons.base_rest.restapi.method装饰器提供所需的信息;

from odoo.addons.base_rest import restapi
from odoo.addons.component.core import Component
from odoo.addons.pydantic.models import BaseModel

class PingMessage(BaseModel):
    message: str


class PingService(Component):
    _inherit = 'base.rest.service'
    _name = 'ping.service'
    _usage = 'ping'
    _collection = 'my_module.services'


    @restapi.method(
        [(["/pong"], "GET")],
        input_param=restapi.PydanticModel(PingMessage),
        output_param=restapi.PydanticModel(PingMessage),
        auth="public",
    )
    def pong(self, ping_message):
        return PingMessage(message = "Received: " + ping_message.message)

错误跟踪器

错误在GitHub问题上跟踪。如果遇到问题,请先检查是否已报告您的问题。如果是您首先发现的,请通过提供详细的和受欢迎的反馈来帮助我们解决问题。

请不要直接联系贡献者寻求支持或帮助解决技术问题。

致谢

作者

  • ACSONE SA/NV

贡献者

维护者

此模块由OCA维护。

Odoo Community Association

OCA,或Odoo社区协会,是一个非营利组织,其使命是支持Odoo功能的协作开发并推广其广泛使用。

此模块是GitHub上OCA/rest-framework项目的组成部分。

欢迎您贡献力量。有关如何贡献的信息,请访问https://odoo-community.org/page/Contribute

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源代码分布

本版本没有可用的源代码分布文件。请参阅有关生成分布存档的教程。

构建分布

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面