mirror of
https://github.com/fastapi/fastapi.git
synced 2025-12-31 02:00:34 -05:00
1f01ce9615
* Updated .py files with Optional tag (up to body_nested_models) * Update optionals * docs_src/ all updates, few I was unsure of * Updated markdown files with Optional param * es: Add Optional typing to index.md * Last of markdown files updated with Optional param * Update highlight lines * it: Add Optional typings * README.md: Update with Optional typings * Update more highlight increments * Update highlights * schema-extra-example.md: Update highlights * updating highlighting on website to reflect .py changes * Update highlighting for query-params & response-directly * Address PR comments * Get rid of unnecessary comment * ⏪ Revert Optional in Chinese docs as it probably also requires changes in text * 🎨 Apply format * ⏪ Revert modified example * ♻️ Simplify example in docs * 📝 Update OpenAPI callback example to use Optional * ✨ Add Optional types to tests * 📝 Update docs about query params, default to using Optional * 🎨 Update code examples line highlighting * 📝 Update nested models docs to use "type parameters" instead of "subtypes" * 📝 Add notes about FastAPI usage of None including: = None and = Query(None) and clarify relationship with Optional[str] * 📝 Add note about response_model_by_alias * ♻️ Simplify query param list example * 🔥 Remove test for removed example * ✅ Update test for updated example Co-authored-by: Christopher Nguyen <chrisngyn99@gmail.com> Co-authored-by: yk396 <yk396@cornell.edu> Co-authored-by: Kai Chen <kaichen120@gmail.com>
84 lines
2.7 KiB
Python
84 lines
2.7 KiB
Python
from typing import Optional
|
|
|
|
from fastapi import Cookie, Depends, FastAPI, Query, WebSocket, 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: Optional[str] = Cookie(None),
|
|
token: Optional[str] = Query(None),
|
|
):
|
|
if session is None and token is None:
|
|
await websocket.close(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: Optional[int] = 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}")
|