deepfos.api.base.get

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

声明一个 GET 接口

适用于 RootAPI、ChildAPI 或 DynamicRootAPI 子类中的方法定义。 被装饰的方法本身只需要返回请求参数字典，例如 param、path、header 或 body，实际 HTTP 调用与返回值解析由 Route 在类创建时接管。

示例

class DemoAPI(DynamicRootAPI):
    module_type = 'DEMO'

    @get('/pet/findByStatus')
    def find_by_status(self, status: str):
        return {'param': {'status': status}}

参数

• endpoint – 接口相对路径。

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

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

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

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

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