docs_src/websockets/tutorial002.py · it老头/FastAPI

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

扫描微信二维码支付

取消

支付完成

richgiteeai

Watch

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

1 Star 0 Fork 76

it老头/FastAPI

forked from Gitee 极速下载/FastAPI

代码 Wiki 统计流水线

服务

加入 Gitee

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

免费加入

已有帐号? 立即登录

文件

master

分支 (155)

标签 (173)

管理

master

dependabot/pip/starlette-gte-0.27.0-and-lt-0.34.0

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

pre-commit-ci-update-config

dependabot/pip/starlette-gte-0.27.0-and-lt-0.33.0

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

fastapi-people

dependabot/pip/pillow-10.1.0

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

dependabot/pip/mkdocs-material-9.4.6

drop-3.7

ref-docs

dependabot/pip/mkdocs-material-9.4.5

dependabot/pip/mkdocs-material-9.4.4

dependabot/pip/mkdocs-material-9.4.3

dependabot/pip/mkdocs-material-9.4.2

dependabot/pip/mkdocs-material-9.4.0

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

dependabot/pip/mkdocs-material-9.3.2

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

0.104.1

0.104.0

0.103.2

0.103.1

0.103.0

0.102.0

0.101.1

0.101.0

0.100.1

0.100.0

0.100.0-beta3

0.99.1

0.100.0-beta2

0.99.0

0.98.0

0.100.0-beta1

0.97.0

0.96.1

0.96.0

0.95.2

克隆/下载

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': # 私人令牌

分支 155

标签 173

FastAPI

docs_src

websockets

tutorial002.py

tutorial002.py 2.78 KB

from typing import Union

from fastapi import (
 Cookie,
 Depends,
 FastAPI,
 Query,
 WebSocket,
 WebSocketException,
 status,
)
from fastapi.responses import HTMLResponse

app = FastAPI()

html = """
<!DOCTYPE html>
<html>
 <head>
 <title>Chat</title>
 </head>
 <body>
 <h1>WebSocket Chat</h1>
 <form action="" onsubmit="sendMessage(event)">
 <label>Item ID: <input type="text" id="itemId" autocomplete="off" value="foo"/></label>
 <label>Token: <input type="text" id="token" autocomplete="off" value="some-key-token"/></label>
 <button onclick="connect(event)">Connect</button>
 <hr>
 <label>Message: <input type="text" id="messageText" autocomplete="off"/></label>
 <button>Send</button>
 </form>
 <ul id='messages'>
 </ul>
 <script>
 var ws = null;
 function connect(event) {
 var itemId = document.getElementById("itemId")
 var token = document.getElementById("token")
 ws = new WebSocket("ws://localhost:8000/items/" + itemId.value + "/ws?token=" + token.value);
 ws.onmessage = function(event) {
 var messages = document.getElementById('messages')
 var message = document.createElement('li')
 var content = document.createTextNode(event.data)
 message.appendChild(content)
 messages.appendChild(message)
 };
 event.preventDefault()
 }
 function sendMessage(event) {
 var input = document.getElementById("messageText")
 ws.send(input.value)
 input.value = ''
 event.preventDefault()
 }
 </script>
 </body>
</html>
"""

@app.get("/")
async def get():
 return HTMLResponse(html)

async def get_cookie_or_token(
 websocket: WebSocket,
 session: Union[str, None] = Cookie(default=None),
 token: Union[str, None] = Query(default=None),
):
 if session is None and token is None:
 raise WebSocketException(code=status.WS_1008_POLICY_VIOLATION)
 return session or token

@app.websocket("/items/{item_id}/ws")
async def websocket_endpoint(
 websocket: WebSocket,
 item_id: str,
 q: Union[int, None] = None,
 cookie_or_token: str = Depends(get_cookie_or_token),
):
 await websocket.accept()
 while True:
 data = await websocket.receive_text()
 await websocket.send_text(
 f"Session cookie or query token value is: {cookie_or_token}"
 )
 if q is not None:
 await websocket.send_text(f"Query parameter q is: {q}")
 await websocket.send_text(f"Message text was: {data}, for item ID: {item_id}")

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

Sebastián Ramírez 提交于 2022年11月14日 00:10 +08:00 . ✨ Re-export Starlette's WebSocketException and add it to docs (#5629)

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

from typing import Union

from fastapi import (
 Cookie,
 Depends,
 FastAPI,
 Query,
 WebSocket,
 WebSocketException,
 status,
)
from fastapi.responses import HTMLResponse

app = FastAPI()

html = """
<!DOCTYPE html>
<html>
 <head>
 <title>Chat</title>
 </head>
 <body>
 <h1>WebSocket Chat</h1>
 <form action="" onsubmit="sendMessage(event)">
 <label>Item ID: <input type="text" id="itemId" autocomplete="off" value="foo"/></label>
 <label>Token: <input type="text" id="token" autocomplete="off" value="some-key-token"/></label>
 <button onclick="connect(event)">Connect</button>
 <hr>
 <label>Message: <input type="text" id="messageText" autocomplete="off"/></label>
 <button>Send</button>
 </form>
 <ul id='messages'>
 </ul>
 <script>
 var ws = null;
 function connect(event) {
 var itemId = document.getElementById("itemId")
 var token = document.getElementById("token")
 ws = new WebSocket("ws://localhost:8000/items/" + itemId.value + "/ws?token=" + token.value);
 ws.onmessage = function(event) {
 var messages = document.getElementById('messages')
 var message = document.createElement('li')
 var content = document.createTextNode(event.data)
 message.appendChild(content)
 messages.appendChild(message)
 };
 event.preventDefault()
 }
 function sendMessage(event) {
 var input = document.getElementById("messageText")
 ws.send(input.value)
 input.value = ''
 event.preventDefault()
 }
 </script>
 </body>
</html>
"""


@app.get("/")
async def get():
 return HTMLResponse(html)


async def get_cookie_or_token(
 websocket: WebSocket,
 session: Union[str, None] = Cookie(default=None),
 token: Union[str, None] = Query(default=None),
):
 if session is None and token is None:
 raise WebSocketException(code=status.WS_1008_POLICY_VIOLATION)
 return session or token


@app.websocket("/items/{item_id}/ws")
async def websocket_endpoint(
 websocket: WebSocket,
 item_id: str,
 q: Union[int, None] = None,
 cookie_or_token: str = Depends(get_cookie_or_token),
):
 await websocket.accept()
 while True:
 data = await websocket.receive_text()
 await websocket.send_text(
 f"Session cookie or query token value is: {cookie_or_token}"
 )
 if q is not None:
 await websocket.send_text(f"Query parameter q is: {q}")
 await websocket.send_text(f"Message text was: {data}, for item ID: {item_id}")