The Scheduler
a42b1ff04e
Issue Manager / issue-manager (push) Has been cancelled
Build Docs / changes (push) Has been cancelled
Build Docs / langs (push) Has been cancelled
Build Docs / build-docs (push) Has been cancelled
Build Docs / docs-all-green (push) Has been cancelled
Conflict detector / main (push) Has been cancelled
Test Redistribute / test-redistribute (fastapi) (push) Has been cancelled
Test Redistribute / test-redistribute (fastapi-slim) (push) Has been cancelled
Test Redistribute / test-redistribute-alls-green (push) Has been cancelled
Test / lint (push) Has been cancelled
Test / test (pydantic-v1, 3.10) (push) Has been cancelled
Test / test (pydantic-v1, 3.11) (push) Has been cancelled
Test / test (pydantic-v1, 3.13) (push) Has been cancelled
Test / test (pydantic-v1, 3.8) (push) Has been cancelled
Test / test (pydantic-v1, 3.9) (push) Has been cancelled
Test / test (pydantic-v2, 3.10) (push) Has been cancelled
Test / test (pydantic-v2, 3.11) (push) Has been cancelled
Test / test (pydantic-v2, 3.12) (push) Has been cancelled
Test / test (pydantic-v2, 3.13) (push) Has been cancelled
Test / test (pydantic-v2, 3.14) (push) Has been cancelled
Test / test (pydantic-v2, 3.8) (push) Has been cancelled
Test / test (pydantic-v2, 3.9) (push) Has been cancelled
Test / coverage-combine (push) Has been cancelled
Test / check (push) Has been cancelled
Label Approved / label-approved (push) Has been cancelled
FastAPI People Contributors / job (push) Has been cancelled
FastAPI People Sponsors / job (push) Has been cancelled
Update Topic Repos / topic-repos (push) Has been cancelled
FastAPI People / job (push) Has been cancelled
Test / test (pydantic-v1, 3.12) (push) Has been cancelled
126 lines
2.7 KiB
Markdown
126 lines
2.7 KiB
Markdown
# 模板
|
||
|
||
**FastAPI** 支持多种模板引擎。
|
||
|
||
Flask 等工具使用的 Jinja2 是最用的模板引擎。
|
||
|
||
在 Starlette 的支持下，**FastAPI** 应用可以直接使用工具轻易地配置 Jinja2。
|
||
|
||
## 安装依赖项
|
||
|
||
安装 `jinja2`：
|
||
|
||
<div class="termy">
|
||
|
||
```console
|
||
$ pip install jinja2
|
||
|
||
---> 100%
|
||
```
|
||
|
||
</div>
|
||
|
||
## 使用 `Jinja2Templates`
|
||
|
||
* 导入 `Jinja2Templates`
|
||
* 创建可复用的 `templates` 对象
|
||
* 在返回模板的*路径操作*中声明 `Request` 参数
|
||
* 使用 `templates` 渲染并返回 `TemplateResponse`， 传递模板的名称、request对象以及一个包含多个键值对（用于Jinja2模板）的"context"字典，
|
||
|
||
{* ../../docs_src/templates/tutorial001.py hl[4,11,15:16] *}
|
||
|
||
/// note | 笔记
|
||
|
||
在FastAPI 0.108.0，Starlette 0.29.0之前，`name`是第一个参数。
|
||
并且，在此之前，`request`对象是作为context的一部分以键值对的形式传递的。
|
||
|
||
///
|
||
|
||
/// tip | 提示
|
||
|
||
通过声明 `response_class=HTMLResponse`，API 文档就能识别响应的对象是 HTML。
|
||
|
||
///
|
||
|
||
/// note | 技术细节
|
||
|
||
您还可以使用 `from starlette.templating import Jinja2Templates`。
|
||
|
||
**FastAPI** 的 `fastapi.templating` 只是为开发者提供的快捷方式。实际上，绝大多数可用响应都直接继承自 Starlette。 `Request` 与 `StaticFiles` 也一样。
|
||
|
||
///
|
||
|
||
## 编写模板
|
||
|
||
编写模板 `templates/item.html`，代码如下：
|
||
|
||
```jinja hl_lines="7"
|
||
{!../../docs_src/templates/templates/item.html!}
|
||
```
|
||
|
||
### 模板上下文
|
||
|
||
在包含如下语句的html中:
|
||
|
||
{% raw %}
|
||
|
||
```jinja
|
||
Item ID: {{ id }}
|
||
```
|
||
|
||
{% endraw %}
|
||
|
||
...这将显示你从"context"字典传递的 `id`:
|
||
|
||
```Python
|
||
{"id": id}
|
||
```
|
||
|
||
例如。当ID为 `42`时, 会渲染成:
|
||
|
||
```html
|
||
Item ID: 42
|
||
```
|
||
|
||
### 模板 `url_for` 参数
|
||
|
||
你还可以在模板内使用 `url_for()`，其参数与*路径操作函数*的参数相同.
|
||
|
||
所以，该部分:
|
||
|
||
{% raw %}
|
||
|
||
```jinja
|
||
<a href="{{ url_for('read_item', id=id) }}">
|
||
```
|
||
|
||
{% endraw %}
|
||
|
||
...将生成一个与处理*路径操作函数* `read_item(id=id)`的URL相同的链接
|
||
|
||
例如。当ID为 `42`时, 会渲染成:
|
||
|
||
```html
|
||
<a href="/items/42">
|
||
```
|
||
|
||
## 模板与静态文件
|
||
|
||
你还可以在模板内部将 `url_for()`用于静态文件，例如你挂载的 `name="static"`的 `StaticFiles`。
|
||
|
||
```jinja hl_lines="4"
|
||
{!../../docs_src/templates/templates/item.html!}
|
||
```
|
||
|
||
本例中，它将链接到 `static/styles.css`中的CSS文件：
|
||
|
||
```CSS hl_lines="4"
|
||
{!../../docs_src/templates/static/styles.css!}
|
||
```
|
||
|
||
因为使用了 `StaticFiles`， **FastAPI** 应用会自动提供位于 URL `/static/styles.css`的 CSS 文件。
|
||
|
||
## 更多说明
|
||
|
||
包括测试模板等更多详情，请参阅 <a href="https://www.starlette.dev/templates/" class="external-link" target="_blank">Starlette 官方文档 - 模板</a>。
|