fastapi/openapi/docs.py · 清风/FastAPI

代码拉取完成,页面将自动刷新

扫描微信二维码支付

取消

支付完成

richgiteeai

Watch

不关注关注所有动态仅关注版本发行动态关注但不提醒动态

1 Star 0 Fork 76

清风/FastAPI

forked from Gitee 极速下载/FastAPI

代码 Wiki 统计流水线

服务

加入 Gitee

与超过 1400万开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)

免费加入

已有帐号? 立即登录

文件

master

分支 (7)

标签 (116)

管理

master

python3.9-3.10

fastapi-people

add-link-to-testdriven-io

release-notes

consistency-star

windows-dev

0.70.0

0.69.0

0.68.2

0.68.1

0.68.0

0.67.0

0.66.1

0.66.0

0.65.3

0.65.2

0.65.1

0.65.0

0.64.0

0.63.0

0.62.0

0.61.2

0.61.1

0.61.0

0.60.2

0.60.1

克隆/下载

HTTPS SSH SVN SVN+SSH 下载ZIP

提示

下载代码请复制以下命令到终端执行

为确保你提交的代码身份被 Gitee 正确识别,请执行以下命令完成配置

git config --global user.name userName 
git config --global user.email userEmail

初次使用 SSH 协议进行代码克隆、推送等操作时,需按下述提示完成 SSH 配置

1 生成 RSA 密钥

2 获取 RSA 公钥内容,并配置到 SSH公钥中

在 Gitee 上使用 SVN,请访问使用指南

使用 HTTPS 协议时,命令行会出现如下账号密码验证步骤。基于安全考虑,Gitee 建议配置并使用私人令牌替代登录密码进行克隆、推送等操作

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # 私人令牌

分支 7

标签 116

FastAPI

fastapi

openapi

docs.py

docs.py 5.41 KB

import json
from typing import Any, Dict, Optional

from fastapi.encoders import jsonable_encoder
from starlette.responses import HTMLResponse

def get_swagger_ui_html(
 *,
 openapi_url: str,
 title: str,
 swagger_js_url: str = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@3/swagger-ui-bundle.js",
 swagger_css_url: str = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@3/swagger-ui.css",
 swagger_favicon_url: str = "https://fastapi.tiangolo.com/img/favicon.png",
 oauth2_redirect_url: Optional[str] = None,
 init_oauth: Optional[Dict[str, Any]] = None,
) -> HTMLResponse:

html = f"""
 <!DOCTYPE html>
 <html>
 <head>
 <link type="text/css" rel="stylesheet" href="{swagger_css_url}">
 <link rel="shortcut icon" href="{swagger_favicon_url}">
 <title>{title}</title>
 </head>
 <body>
 <div id="swagger-ui">
 </div>
 <script src="{swagger_js_url}"></script>
 
 <script>
 const ui = SwaggerUIBundle({{
 url: '{openapi_url}',
 """

if oauth2_redirect_url:
 html += f"oauth2RedirectUrl: window.location.origin + '{oauth2_redirect_url}',"

html += """
 dom_id: '#swagger-ui',
 presets: [
 SwaggerUIBundle.presets.apis,
 SwaggerUIBundle.SwaggerUIStandalonePreset
 ],
 layout: "BaseLayout",
 deepLinking: true,
 showExtensions: true,
 showCommonExtensions: true
 })"""

if init_oauth:
 html += f"""
 ui.initOAuth({json.dumps(jsonable_encoder(init_oauth))})
 """

html += """
 </script>
 </body>
 </html>
 """
 return HTMLResponse(html)

def get_redoc_html(
 *,
 openapi_url: str,
 title: str,
 redoc_js_url: str = "https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js",
 redoc_favicon_url: str = "https://fastapi.tiangolo.com/img/favicon.png",
 with_google_fonts: bool = True,
) -> HTMLResponse:
 html = f"""
 <!DOCTYPE html>
 <html>
 <head>
 <title>{title}</title>
 
 <meta charset="utf-8"/>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 """
 if with_google_fonts:
 html += """
 <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
 """
 html += f"""
 <link rel="shortcut icon" href="{redoc_favicon_url}">
 
 <style>
 body {{
 margin: 0;
 padding: 0;
 }}
 </style>
 </head>
 <body>
 <redoc spec-url="{openapi_url}"></redoc>
 <script src="{redoc_js_url}"> </script>
 </body>
 </html>
 """
 return HTMLResponse(html)

def get_swagger_ui_oauth2_redirect_html() -> HTMLResponse:
 html = """
 <!DOCTYPE html>
 <html lang="en-US">
 <body onload="run()">
 </body>
 </html>
 <script>
 'use strict';
 function run () {
 var oauth2 = window.opener.swaggerUIRedirectOauth2;
 var sentState = oauth2.state;
 var redirectUrl = oauth2.redirectUrl;
 var isValid, qp, arr;

if (/code|token|error/.test(window.location.hash)) {
 qp = window.location.hash.substring(1);
 } else {
 qp = location.search.substring(1);
 }

arr = qp.split("&")
 arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';})
 qp = qp ? JSON.parse('{' + arr.join() + '}',
 function (key, value) {
 return key === "" ? value : decodeURIComponent(value)
 }
 ) : {}

isValid = qp.state === sentState

if ((
 oauth2.auth.schema.get("flow") === "accessCode"||
 oauth2.auth.schema.get("flow") === "authorizationCode"
 ) && !oauth2.auth.code) {
 if (!isValid) {
 oauth2.errCb({
 authId: oauth2.auth.name,
 source: "auth",
 level: "warning",
 message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server"
 });
 }

if (qp.code) {
 delete oauth2.state;
 oauth2.auth.code = qp.code;
 oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
 } else {
 let oauthErrorMsg
 if (qp.error) {
 oauthErrorMsg = "["+qp.error+"]: " +
 (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
 (qp.error_uri ? "More info: "+qp.error_uri : "");
 }

oauth2.errCb({
 authId: oauth2.auth.name,
 source: "auth",
 level: "error",
 message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server"
 });
 }
 } else {
 oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
 }
 window.close();
 }
 </script>
 """
 return HTMLResponse(content=html)

一键复制编辑原始数据按行查看历史

Sebastián Ramírez 提交于 2020年12月21日 02:50 +08:00 . ✨ Improve type annotations, add support for mypy --strict, internally ...

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177

import json
from typing import Any, Dict, Optional

from fastapi.encoders import jsonable_encoder
from starlette.responses import HTMLResponse


def get_swagger_ui_html(
 *,
 openapi_url: str,
 title: str,
 swagger_js_url: str = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@3/swagger-ui-bundle.js",
 swagger_css_url: str = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@3/swagger-ui.css",
 swagger_favicon_url: str = "https://fastapi.tiangolo.com/img/favicon.png",
 oauth2_redirect_url: Optional[str] = None,
 init_oauth: Optional[Dict[str, Any]] = None,
) -> HTMLResponse:

 html = f"""
 <!DOCTYPE html>
 <html>
 <head>
 <link type="text/css" rel="stylesheet" href="{swagger_css_url}">
 <link rel="shortcut icon" href="{swagger_favicon_url}">
 <title>{title}</title>
 </head>
 <body>
 <div id="swagger-ui">
 </div>
 <script src="{swagger_js_url}"></script>
 <!-- `SwaggerUIBundle` is now available on the page -->
 <script>
 const ui = SwaggerUIBundle({{
 url: '{openapi_url}',
 """

 if oauth2_redirect_url:
 html += f"oauth2RedirectUrl: window.location.origin + '{oauth2_redirect_url}',"

 html += """
 dom_id: '#swagger-ui',
 presets: [
 SwaggerUIBundle.presets.apis,
 SwaggerUIBundle.SwaggerUIStandalonePreset
 ],
 layout: "BaseLayout",
 deepLinking: true,
 showExtensions: true,
 showCommonExtensions: true
 })"""

 if init_oauth:
 html += f"""
 ui.initOAuth({json.dumps(jsonable_encoder(init_oauth))})
 """

 html += """
 </script>
 </body>
 </html>
 """
 return HTMLResponse(html)


def get_redoc_html(
 *,
 openapi_url: str,
 title: str,
 redoc_js_url: str = "https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js",
 redoc_favicon_url: str = "https://fastapi.tiangolo.com/img/favicon.png",
 with_google_fonts: bool = True,
) -> HTMLResponse:
 html = f"""
 <!DOCTYPE html>
 <html>
 <head>
 <title>{title}</title>
 <!-- needed for adaptive design -->
 <meta charset="utf-8"/>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 """
 if with_google_fonts:
 html += """
 <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
 """
 html += f"""
 <link rel="shortcut icon" href="{redoc_favicon_url}">
 <!--
 ReDoc doesn't change outer page styles
 -->
 <style>
 body {{
 margin: 0;
 padding: 0;
 }}
 </style>
 </head>
 <body>
 <redoc spec-url="{openapi_url}"></redoc>
 <script src="{redoc_js_url}"> </script>
 </body>
 </html>
 """
 return HTMLResponse(html)


def get_swagger_ui_oauth2_redirect_html() -> HTMLResponse:
 html = """
 <!DOCTYPE html>
 <html lang="en-US">
 <body onload="run()">
 </body>
 </html>
 <script>
 'use strict';
 function run () {
 var oauth2 = window.opener.swaggerUIRedirectOauth2;
 var sentState = oauth2.state;
 var redirectUrl = oauth2.redirectUrl;
 var isValid, qp, arr;

 if (/code|token|error/.test(window.location.hash)) {
 qp = window.location.hash.substring(1);
 } else {
 qp = location.search.substring(1);
 }

 arr = qp.split("&")
 arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';})
 qp = qp ? JSON.parse('{' + arr.join() + '}',
 function (key, value) {
 return key === "" ? value : decodeURIComponent(value)
 }
 ) : {}

 isValid = qp.state === sentState

 if ((
 oauth2.auth.schema.get("flow") === "accessCode"||
 oauth2.auth.schema.get("flow") === "authorizationCode"
 ) && !oauth2.auth.code) {
 if (!isValid) {
 oauth2.errCb({
 authId: oauth2.auth.name,
 source: "auth",
 level: "warning",
 message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server"
 });
 }

 if (qp.code) {
 delete oauth2.state;
 oauth2.auth.code = qp.code;
 oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
 } else {
 let oauthErrorMsg
 if (qp.error) {
 oauthErrorMsg = "["+qp.error+"]: " +
 (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
 (qp.error_uri ? "More info: "+qp.error_uri : "");
 }

 oauth2.errCb({
 authId: oauth2.auth.name,
 source: "auth",
 level: "error",
 message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server"
 });
 }
 } else {
 oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
 }
 window.close();
 }
 </script>
 """
 return HTMLResponse(content=html)