如何在FastAPI提供的Redoc页面默认开启响应示例的「全部展开」?
配置Redoc默认展开所有响应示例
要让Redoc默认展开所有响应示例,你可以通过在OpenAPI Schema中添加x-redoc扩展配置来实现。修改你的custom_openapi()函数,在生成的openapi_schema里加入Redoc的自定义配置项即可:
def custom_openapi(): if app.openapi_schema: return app.openapi_schema openapi_schema = get_openapi( title=title, version="1.0", description=description, routes=app.routes, ) # 配置Redoc默认展开所有响应 openapi_schema["x-redoc"] = { "expandResponses": "all", "expandDefaultServerVariables": True } app.openapi_schema = openapi_schema return app.openapi_schema openapi_schema = custom_openapi()
其中expandResponses: "all"是核心配置,它会让Redoc加载时自动展开所有接口的响应示例,无需手动点击「Expand all」按钮。
内容的提问来源于stack exchange,提问作者ovefuz ovefuze
相关产品推荐
相关产品推荐

