局域网环境生成fastapi接口文档的方法
2020/12/29 8:08:18
本文主要是介绍局域网环境生成fastapi接口文档的方法,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!
fastapi自动生成的接口文档,基于Swagger UI, 但是在内部局域网环境无法访问cdn,因此无法自动生成docs接口文档.
如果要在内网环境生成docs接口文档,需要修改示例代码如下:
from fastapi import FastAPI import os from fastapi.openapi.docs import ( get_redoc_html, get_swagger_ui_html, get_swagger_ui_oauth2_redirect_html, ) from fastapi.staticfiles import StaticFiles app = FastAPI(docs_url=None, redoc_url=None) root = os.path.abspath(os.path.join(os.path.basename(__file__), "../..")) print(root) app.mount("/static", StaticFiles(directory=f"{root}/static"), name="static") @app.get("/docs", include_in_schema=False) async def custom_swagger_ui_html(): return get_swagger_ui_html( openapi_url=app.openapi_url, title=app.title + " - Swagger UI", oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url, swagger_js_url="/static/swagger-ui-bundle.js", swagger_css_url="/static/swagger-ui.css", ) @app.get(app.swagger_ui_oauth2_redirect_url, include_in_schema=False) async def swagger_ui_redirect(): return get_swagger_ui_oauth2_redirect_html() @app.get("/redoc", include_in_schema=False) async def redoc_html(): return get_redoc_html( openapi_url=app.openapi_url, title=app.title + " - ReDoc", redoc_js_url="/static/redoc.standalone.js", ) @app.get( "/users/{username}", tags=["test"], name="TESTROUTER", description="TESTROUTER", ) async def read_user(username: str): return {"message": f"Hello {username}"} if __name__ == '__main__': import uvicorn uvicorn.run(app, host="127.0.0.1", port=8000)
> 注: 需要把 swagger-ui.css
和 swagger-ui-bundle.js
放到static文件夹下, 此文件夹放在上面示例代码的上一级目录下.
这篇关于局域网环境生成fastapi接口文档的方法的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!
- 2024-05-19永别了,微服务架构!
- 2024-05-15鸿蒙生态设备数量超8亿台
- 2024-05-13TiDB + ES:转转业财系统亿级数据存储优化实践
- 2024-05-09“2024鸿蒙零基础快速实战-仿抖音App开发(ArkTS版)”实战课程已上线
- 2024-05-09聊聊如何通过arthas-tunnel-server来远程管理所有需要arthas监控的应用
- 2024-05-09log4j2这么配就对了
- 2024-05-09nginx修改Content-Type
- 2024-05-09Redis多数据源,看这篇就够了
- 2024-05-09Google Chrome驱动程序 124.0.6367.62(正式版本)去哪下载?
- 2024-05-09有没有大佬知道这种数据应该怎么抓取呀?