You need to enable JavaScript to run this app. 如何在FastAPI中隐藏OpenAPI UI展示的请求输入参数
优惠活动
大模型
产品
解决方案
定价
更多

如何在FastAPI中隐藏OpenAPI UI展示的请求输入参数

隐藏OpenAPI请求参数的方法

给需要隐藏的参数实例化时传入include_in_schema=False即可,该配置仅控制参数是否出现在OpenAPI生成的文档结构中,不影响参数的实际接收、解析逻辑。该参数对Query、Header、Cookie、Path等所有参数类型都生效,可按需配置。

针对示例中的user_agent Header参数,修改后的完整代码如下:

from typing import Optional
from fastapi import FastAPI, Header, Body

app = FastAPI()
   
@app.get("/items/")
async def read_items(
       user_agent: Optional[str] = Header(None, include_in_schema=False), 
       size: Optional[int] = Body(None)):
    return {"User-Agent": user_agent}

验证效果

  • 启动服务后访问OpenAPI UI(默认路径为/docs),可看到user_agent参数已从参数列表中移除
  • 实际发送带有User-Agent请求头的请求时,接口仍能正常读取并返回对应值,不会影响原有业务逻辑

内容的提问来源于stack exchange,提问作者Mindaugas Jaraminas

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.02 18:27:04