fastapi/openapi/docs.py · dev_team/FastAPI

Fetch the repository succeeded.

richgiteeai

Watch

Unwatch Watching Releases Only Ignoring

1 Star 0 Fork 74

dev_team/FastAPI

forked from Gitee 极速下载/FastAPI

Code Wiki Insights Pipelines

Service

Tencent Cloud Serverless

Create your Gitee Account

Explore and code with more than 14 million developers,Free private repositories !:)

Already have an account? Sign in

文件

master

Branches (64)

Tags (144)

Manage

master

dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-2.0.2

fastapi-people

dependabot/pip/black-23.1.0

pre-commit-ci-update-config

update-sponsors

dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-2.0.1

response-model-error-update

dependabot/pip/types-ujson-5.7.0.0

dependabot/pip/black-22.12.0

dependabot/pip/mkdocs-material-gte-8.1.4-and-lt-10.0.0

dependabot/github_actions/dawidd6/action-download-artifact-2.24.3

dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-1.4.47

typing-doc

dependabot/pip/coverage-toml--gte-6.5.0-and-lt-8.0

dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-1.4.46

dependabot/pip/mypy-0.991

dependabot/pip/uvicorn-standard--gte-0.12.0-and-lt-0.21.0

dependabot/pip/types-ujson-5.6.0.0

dependabot/github_actions/pypa/gh-action-pypi-publish-1.6.4

0.89.1

0.89.0

0.88.0

0.87.0

0.86.0

0.85.2

0.85.1

0.85.0

0.84.0

0.83.0

0.82.0

0.81.0

0.80.0

0.79.1

0.79.0

0.78.0

0.77.1

0.77.0

0.76.0

0.75.2

Clone or Download

Clone/Download

HTTPS SSH SVN SVN+SSH Download ZIP

Prompt

To download the code, please copy the following command and execute it in the terminal

To ensure that your submitted code identity is correctly recognized by Gitee, please execute the following command.

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

When using the SSH protocol for the first time to clone or push code, follow the prompts below to complete the SSH configuration.

1 Generate RSA keys.

2 Obtain the content of the RSA public key and configure it in SSH Public Keys

To use SVN on Gitee, please visit the usage guide

When using the HTTPS protocol, the command line will prompt for account and password verification as follows. For security reasons, Gitee recommends configure and use personal access tokens instead of login passwords for cloning, pushing, and other operations.

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

Password for 'https://userName@gitee.com': # Private Token

Branches 64

Tags 144

FastAPI

fastapi

openapi

docs.py

docs.py 6.38 KB

import json
from typing import Any, Dict, Optional

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

swagger_ui_default_parameters = {
 "dom_id": "#swagger-ui",
 "layout": "BaseLayout",
 "deepLinking": True,
 "showExtensions": True,
 "showCommonExtensions": True,
}

def get_swagger_ui_html(
 *,
 openapi_url: str,
 title: str,
 swagger_js_url: str = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@4/swagger-ui-bundle.js",
 swagger_css_url: str = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@4/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,
 swagger_ui_parameters: Optional[Dict[str, Any]] = None,
) -> HTMLResponse:
 current_swagger_ui_parameters = swagger_ui_default_parameters.copy()
 if swagger_ui_parameters:
 current_swagger_ui_parameters.update(swagger_ui_parameters)

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}',
 """

for key, value in current_swagger_ui_parameters.items():
 html += f"{json.dumps(key)}: {json.dumps(jsonable_encoder(value))},\n"

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

html += """
 presets: [
 SwaggerUIBundle.presets.apis,
 SwaggerUIBundle.SwaggerUIStandalonePreset
 ],
 })"""

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>
 <noscript>
 ReDoc requires Javascript to function. Please enable it to browse the documentation.
 </noscript>
 <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:
 # copied from https://github.com/swagger-api/swagger-ui/blob/v4.14.0/dist/oauth2-redirect.html
 html = """
 <!doctype html>
 <html lang="en-US">
 <head>
 <title>Swagger UI: OAuth2 Redirect</title>
 </head>
 <body>
 <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).replace('?', '&');
 } 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.schema.get("flow") === "authorization_code"
 ) && !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. The 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();
 }

if (document.readyState !== 'loading') {
 run();
 } else {
 document.addEventListener('DOMContentLoaded', function () {
 run();
 });
 }
 </script>
 </body>
 </html>
 """
 return HTMLResponse(content=html)

Copy Edit Raw Blame History

Erik Vroon authored 2022年08月26日 21:56 +08:00 . ✨ Add ReDoc <noscript> warning when JS is disabled (#5074)

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 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203

import json
from typing import Any, Dict, Optional

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

swagger_ui_default_parameters = {
 "dom_id": "#swagger-ui",
 "layout": "BaseLayout",
 "deepLinking": True,
 "showExtensions": True,
 "showCommonExtensions": True,
}


def get_swagger_ui_html(
 *,
 openapi_url: str,
 title: str,
 swagger_js_url: str = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@4/swagger-ui-bundle.js",
 swagger_css_url: str = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@4/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,
 swagger_ui_parameters: Optional[Dict[str, Any]] = None,
) -> HTMLResponse:
 current_swagger_ui_parameters = swagger_ui_default_parameters.copy()
 if swagger_ui_parameters:
 current_swagger_ui_parameters.update(swagger_ui_parameters)

 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}',
 """

 for key, value in current_swagger_ui_parameters.items():
 html += f"{json.dumps(key)}: {json.dumps(jsonable_encoder(value))},\n"

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

 html += """
 presets: [
 SwaggerUIBundle.presets.apis,
 SwaggerUIBundle.SwaggerUIStandalonePreset
 ],
 })"""

 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>
 <noscript>
 ReDoc requires Javascript to function. Please enable it to browse the documentation.
 </noscript>
 <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:
 # copied from https://github.com/swagger-api/swagger-ui/blob/v4.14.0/dist/oauth2-redirect.html
 html = """
 <!doctype html>
 <html lang="en-US">
 <head>
 <title>Swagger UI: OAuth2 Redirect</title>
 </head>
 <body>
 <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).replace('?', '&');
 } 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.schema.get("flow") === "authorization_code"
 ) && !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. The 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();
 }

 if (document.readyState !== 'loading') {
 run();
 } else {
 document.addEventListener('DOMContentLoaded', function () {
 run();
 });
 }
 </script>
 </body>
 </html>
 """
 return HTMLResponse(content=html)