API JSON架构验证与可选元素使用Pyd的

Question

我使用来自pydantic的fastapi和BaseModel来验证和记录api返回的JSON模式。

这适用于固定返回，但我有更改返回的可选参数，因此我想将其包含在验证中，但当参数丢失并且该字段未在API中返回时，它不会失败。

例如：我有一个名为透明度的可选布尔参数，当它设置为 true 时，我返回一个名为 search_transparency 的块，并返回弹性查询。

{
  "info": {
    "totalrecords": 52
  },
  "records": [],
  "search_transparency": {"full_query": "blah blah"}
}

如果未设置参数 transparency=true，我希望返回为：

{
  "info": {
    "totalrecords": 52
  },
  "records": []
}

但是，当我在pydantic中将该元素设置为可选时，我得到的是返回以下内容：

{
  "info": {
    "totalrecords": 52
  },
  "records": [],
  "search_transparency": None
}

我对记录下的字段有类似的东西。默认值是字段的最小返回，但是如果您设置参数满=真，那么您会返回更多字段。我想以类似的方式处理这个问题，字段只是不存在，而不是显示为无的值。

这就是我用pydantic处理的方式：

class Info(BaseModel):
    totalrecords: int

class Transparency(BaseModel):
    full_query: str

class V1Place(BaseModel):
    name: str

class V1PlaceAPI(BaseModel):
    info: Info
    records: List[V1Place] = []
    search_transparency: Optional[Transparency]

这就是我用fastapi强制验证的方式：

< code > @ app . get("/API/v1/place/search "，response_model=V1PlaceAPI，tags=["v1_api"])

我怀疑也许我试图实现的是糟糕的 API 实践，也许我不应该有可变回报。

我应该创建多个单独的endpoint来处理这个问题吗？

例如api/v1/place/search？q=测试vsapi/v1/place/full/transparent/search？q=测试

编辑

我的API函数的更多细节:

@app.get("/api/v1/place/search", response_model=V1PlaceAPI, tags=["v1_api"])

def v1_place_search(q: str = Query(None, min_length=3, max_length=500, title="search through all place fields"),
                    transparency: Optional[bool] = None,
                    offset: Optional[int] = Query(0),
                    limit: Optional[int] = Query(15)):

    search_limit = offset + limit

    results, transparency_query = ESQuery(client=es_client,
                                          index='places',
                                          transparency=transparency,
                                          track_hits=True,
                                          offset=offset,
                                          limit=search_limit)

    return v1_place_parse(results.to_dict(), 
    show_transparency=transparency_query)

其中ESQuery仅返回弹性搜索响应。这是我的解析函数：

def v1_place_parse(resp, show_transparency=None):
    """This takes a response from elasticsearch and parses it for our legacy V1 elasticapi

    Args:
        resp (dict): This is the response from Search.execute after passing to_dict()

    Returns:
        dict: A dictionary that is passed to API
    """

    new_resp = {}
    total_records = resp['hits']['total']['value']
    query_records = len(resp.get('hits', {}).get('hits', []))

    new_resp['info'] = {'totalrecords': total_records,
                        'totalrecords_relation': resp['hits']['total']['relation'],
                        'totalrecordsperquery': query_records,
                        }
    if show_transparency is not None:
        search_string = show_transparency.get('query', '')
        new_resp['search_transparency'] = {'full_query': str(search_string),
                                           'components': {}}
    new_resp['records'] = []
    for hit in resp.get('hits', {}).get('hits', []):
        new_record = hit['_source']
        new_resp['records'].append(new_record)

    return new_resp

Answer 1

如果该字段是无可以完成工作，则可能排除该字段。

只需添加一个 response_model_exclude_none = True 作为路径参数

@app.get(
    "/api/v1/place/search",
    response_model=V1PlaceAPI,
    tags=["v1_api"],
    response_model_exclude_none=True,
)

您可以自定义您的响应模型，甚至更多，这里是我的一个很好的解释的答案，我真的建议你看看。