📝 Add API reference page for fastapi.sse (#15930)

Co-authored-by: Cursor <cursoragent@cursor.com>

diff --git a/docs/en/docs/reference/sse.md b/docs/en/docs/reference/sse.md
new file mode 100644 (file)
index 0000000..5b447af
--- /dev/null
+++ b/docs/en/docs/reference/sse.md
@@ -0,0 +1,17 @@
+# Server-Sent Events - `EventSourceResponse` and `ServerSentEvent`
+
+To stream Server-Sent Events (SSE), use `yield` in your *path operation function* and set `response_class=EventSourceResponse`.
+
+If you need to set SSE fields like `event`, `id`, `retry`, or `comment`, you can `yield` `ServerSentEvent` objects instead of plain data.
+
+Read more about it in the [FastAPI docs for Server-Sent Events (SSE)](https://fastapi.tiangolo.com/tutorial/server-sent-events/).
+
+You can import them directly from `fastapi.sse`:
+
+```python
+from fastapi.sse import EventSourceResponse, ServerSentEvent
+```
+
+::: fastapi.sse.EventSourceResponse
+
+::: fastapi.sse.ServerSentEvent

diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml
index 0a762a40d4d39298c7ee7d72805b0940bd01dba6..9bcdbd652d71fc8b8a994019e6fddd7b3d125441 100644 (file)
--- a/docs/en/mkdocs.yml
+++ b/docs/en/mkdocs.yml
@@ -211,6 +211,7 @@ nav:
   - reference/httpconnection.md
   - reference/response.md
   - reference/responses.md
+  - reference/sse.md
   - reference/middleware.md
   - "":
     - reference/openapi/index.md