fastapi 如何实现 swagger 隐藏某个具体 api 呢

2020-06-12 09:14:36 +08:00
 yumenlong
想用 fastapi 来做个小站,提供 api,但部分接口如注册接口这些想隐藏一下,不在 swagger 显示,请问如何实现.
2663 次点击
所在节点    Python
3 条回复
mirrorpen
2020-06-12 09:18:41 +08:00
那注册接口不写 swagger 注释不就行了吗?是这个意思吗..
yRebelHero
2020-06-12 09:22:23 +08:00
yumenlong
2020-06-12 09:46:41 +08:00
找到了,@app.get("/items/", include_in_schema=False) To exclude a path operation from the generated OpenAPI schema (and thus, from the automatic documentation systems), use the parameter include_in_schema and set it to False;

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/680871

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX