V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
推荐学习书目
Learn Python the Hard Way
Python Sites
PyPI - Python Package Index
http://diveintopython.org/toc/index.html
Pocoo
值得关注的项目
PyPy
Celery
Jinja2
Read the Docs
gevent
pyenv
virtualenv
Stackless Python
Beautiful Soup
结巴中文分词
Green Unicorn
Sentry
Shovel
Pyflakes
pytest
Python 编程
pep8 Checker
Styles
PEP 8
Google Python Style Guide
Code Style from The Hitchhiker's Guide
yumenlong
V2EX  ›  Python

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

  •  
  •   yumenlong · 2020-06-12 09:14:36 +08:00 · 2642 次点击
    这是一个创建于 1627 天前的主题,其中的信息可能已经有所发展或是发生改变。
    想用 fastapi 来做个小站,提供 api,但部分接口如注册接口这些想隐藏一下,不在 swagger 显示,请问如何实现.
    mirrorpen
        1
    mirrorpen  
       2020-06-12 09:18:41 +08:00
    那注册接口不写 swagger 注释不就行了吗?是这个意思吗..
    yRebelHero
        2
    yRebelHero  
       2020-06-12 09:22:23 +08:00
    yumenlong
        3
    yumenlong  
    OP
       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;
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3204 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 23ms · UTC 13:16 · PVG 21:16 · LAX 05:16 · JFK 08:16
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.