如何调整FastAPI/Swagger UI中接口参数的显示顺序?
调整FastAPI Swagger UI中参数显示顺序的方案
可以通过为related_items的Query参数设置order属性实现需求,无需将参数移入Pydantic模型,同时保留「Add string item」按钮:
核心逻辑:FastAPI 0.95.0及以上版本支持为
Query、Path等参数设置order值,用于控制OpenAPI文档(含Swagger UI)中的参数排序。默认情况下,通过Depends()展开的Pydantic模型字段order为0,显式声明的Query参数默认order为1,因此会排在模型字段之前。只需给related_items设置更大的order值,就能让它显示在模型字段之后。修改后代码示例:
from typing import List from fastapi import FastAPI, Query, Depends from pydantic import BaseModel class Item(BaseModel): item_x: str item_y: str app = FastAPI() @app.get("/items") async def read_items( item: Item = Depends(), related_items: List[str] = Query(None, order=10) # 增大order值调整排序位置 ): return {"item": item.dict(), "related_items": related_items}
- 额外说明:如果需要精细控制Pydantic模型内部字段的显示顺序,也可以在模型字段中使用
Field指定order值,例如:
from pydantic import BaseModel, Field class Item(BaseModel): item_x: str = Field(..., order=1) item_y: str = Field(..., order=2)
但针对你的需求,仅调整related_items的order即可满足要求。
内容的提问来源于stack exchange,提问作者khoshahmad
相关产品推荐
相关产品推荐

