45 lines
1.4 KiB
Python
45 lines
1.4 KiB
Python
|
# -*- coding: utf-8 -*-
|
|||
|
|
# @version : 1.0
|
|||
|
|
# @Create Time : 2023/11/16 16:44
|
|||
|
|
# @File : views.py
|
|||
|
|
# @IDE : PyCharm
|
|||
|
|
# @desc : 项目文档
|
|||
|
|
|
|||
|
|
|
|||
|
|
# 自定义接口文档静态文件：https://fastapi.tiangolo.com/how-to/custom-docs-ui-assets/
|
|||
|
|
|
|||
|
|
from fastapi import FastAPI
|
|||
|
|
from fastapi.openapi.docs import (
|
|||
|
|
get_redoc_html,
|
|||
|
|
get_swagger_ui_html,
|
|||
|
|
get_swagger_ui_oauth2_redirect_html,
|
|||
|
|
)
|
|||
|
|
|
|||
|
|
|
|||
|
|
def custom_api_docs(app: FastAPI):
|
|||
|
|
"""
|
|||
|
|
自定义配置接口本地静态文档
|
|||
|
|
"""
|
|||
|
|
|
|||
|
|
@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="/media/swagger_ui/swagger-ui-bundle.js",
|
|||
|
|
swagger_css_url="/media/swagger_ui/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 custom_redoc_html():
|
|||
|
|
return get_redoc_html(
|
|||
|
|
openapi_url=app.openapi_url,
|
|||
|
|
title=app.title + " - ReDoc",
|
|||
|
|
redoc_js_url="/media/redoc_ui/redoc.standalone.js",
|
|||
|
|
)
|