deepfos.api.base.post

deepfos.api.base.post = <deepfos.api.base.DummyDeco object>

声明一个 POST 接口

适用于 RootAPIChildAPIDynamicRootAPI 子类中的方法定义。 被装饰的方法本身只需要返回请求参数字典,例如 parampathheaderbody,实际 HTTP 调用与返回值解析由 Route 在类创建时接管, 请求体会按 jsondata 或原始字节方式发送

示例

class DemoAPI(DynamicRootAPI):
    module_type = 'DEMO'

    @post('/pet')
    def create_pet(self, payload):
        return {'body': payload}
参数
  • endpoint – 接口相对路径。

  • resp_model – 返回模型,可为 Pydantic 模型或类型注解。

  • retries – 调用失败时的重试次数。

  • allow_none – 是否允许响应 data 为空。

  • raise_false – 当接口响应 status=False 时是否抛错。

  • data_wrapped – 响应体是否采用 {status, data, …} 包装。