png - Code Search

docs/zh/docs/tutorial/metadata.md

你可以按如下方式设置它们：

{* ../../docs_src/metadata/tutorial001.py hl[4:6] *}

/// tip

您可以在 `description` 字段中编写 Markdown，它将在输出中呈现。

///

通过这样设置，自动 API 文档看起来会像：

<img src="/img/tutorial/metadata/image01.png">

## 标签元数据

### 创建标签元数据

让我们在带有标签的示例中为 `users` 和 `items` 试一下。

创建标签元数据并把它传递给 `openapi_tags` 参数：

{* ../../docs_src/metadata/tutorial004.py hl[3:16,18] *}

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Mon Nov 18 02:25:44 GMT 2024

- 4.5K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/zh/docs/tutorial/request-form-models.md

**FastAPI** 将从请求中的**表单数据**中**提取**出**每个字段**的数据，并提供您定义的 Pydantic 模型。

## 检查文档

您可以在文档 UI 中验证它，地址为 `/docs` ：

<div class="screenshot">
<img src="/img/tutorial/request-form-models/image01.png">
</div>

## 禁止额外的表单字段

在某些特殊使用情况下（可能并不常见），您可能希望将表单字段**限制**为仅在 Pydantic 模型中声明过的字段，并**禁止**任何**额外**的字段。

/// note

自 FastAPI 版本 `0.114.0` 起支持此功能。🤓

///

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Tue Dec 10 20:36:08 GMT 2024

- 2.1K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/zh/docs/tutorial/security/simple-oauth2.md

### 身份验证

点击**Authorize**按钮。

使用以下凭证：

用户名：`johndoe`

密码：`secret`

<img src="https://fastapi.tiangolo.com/img/tutorial/security/image04.png">

通过身份验证后，显示下图所示的内容：

<img src="https://fastapi.tiangolo.com/img/tutorial/security/image05.png">

### 获取当前用户数据

使用 `/users/me` 路径的 `GET` 操作。

可以提取如下当前用户数据：

```JSON
{
  "username": "johndoe",
  "email": "******@****.***",

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Mon Nov 18 02:25:44 GMT 2024

- 8.6K bytes

- Click Count (0)

github.com/codelibs/fess

src/main/webapp/WEB-INF/orig/view/login/index.jsp

<![endif]-->
</head>
<body class="hold-transition login-page">
	<div class="login-box">
		<div class="login-logo">
			<la:link href="/">
				<img src="${fe:url('/images/logo-top.png')}"
					alt="<la:message key="labels.header_brand_name" />" />
			</la:link>
		</div>
		<div class="notification">${notification}</div>
		<div class="card">
			<div class="card-body login-card-body">

Created: Sat Dec 20 09:19:18 GMT 2025

- Last Modified: Sat Jan 18 12:09:07 GMT 2025

- 3K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/de/docs/tutorial/metadata.md

Sie können Markdown im Feld `description` verwenden, und es wird in der Ausgabe gerendert.

///

Mit dieser Konfiguration würde die automatische API-Dokumentation wie folgt aussehen:

<img src="/img/tutorial/metadata/image01.png">

## Lizenzkennung { #license-identifier }

Seit OpenAPI 3.1.0 und FastAPI 0.99.0 können Sie die `license_info` auch mit einem `identifier` anstelle einer `url` festlegen.

Zum Beispiel:

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Wed Dec 17 20:41:43 GMT 2025

- 6.9K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/es/docs/tutorial/metadata.md

Puedes escribir Markdown en el campo `description` y se mostrará en el resultado.

///

Con esta configuración, la documentación automática de la API se vería así:

<img src="/img/tutorial/metadata/image01.png">

## Identificador de licencia { #license-identifier }

Desde OpenAPI 3.1.0 y FastAPI 0.99.0, también puedes establecer la `license_info` con un `identifier` en lugar de una `url`.

Por ejemplo:

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Wed Dec 17 20:41:43 GMT 2025

- 6.4K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/de/docs/tutorial/header-param-models.md

## Die Dokumentation testen { #check-the-docs }

Sie können die erforderlichen Header in der Dokumentationsoberfläche unter `/docs` sehen:

<div class="screenshot">
<img src="/img/tutorial/header-param-models/image01.png">
</div>

## Zusätzliche Header verbieten { #forbid-extra-headers }

In einigen speziellen Anwendungsfällen (wahrscheinlich nicht sehr häufig) möchten Sie möglicherweise die **Header einschränken**, die Sie erhalten möchten.

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Sat Sep 20 15:10:09 GMT 2025

- 3.1K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/header-param-models.md

## Check the Docs { #check-the-docs }

You can see the required headers in the docs UI at `/docs`:

<div class="screenshot">
<img src="/img/tutorial/header-param-models/image01.png">
</div>

## Forbid Extra Headers { #forbid-extra-headers }

In some special use cases (probably not very common), you might want to **restrict** the headers that you want to receive.

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Sun Aug 31 09:15:41 GMT 2025

- 2.6K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/ko/docs/tutorial/query-param-models.md

**FastAPI**는 요청의 **쿼리 매개변수**에서 **각 필드**의 데이터를 **추출**해 정의한 Pydantic 모델로 제공합니다.

## 문서 확인하기

`/docs` 경로의 API 문서에서 매개변수를 확인할 수 있습니다.

<div class="screenshot">
<img src="/img/tutorial/query-param-models/image01.png">
</div>

## 추가 쿼리 매개변수 금지

몇몇의 특이한 경우에 (흔치 않지만), 허용할 쿼리 매개변수를 **제한**해야할 수 있습니다.

Pydantic 모델 설정에서 `extra` 필드를 `forbid` 로 설정할 수 있습니다.

{* ../../docs_src/query_param_models/tutorial002_an_py310.py hl[10] *}

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Wed Nov 20 19:24:08 GMT 2024

- 2.3K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/ko/docs/tutorial/response-model.md

## 문서에서 보기

자동 생성 문서를 보면 입력 모델과 출력 모델이 각자의 JSON 스키마를 가지고 있음을 확인할 수 있습니다:

<img src="/img/tutorial/response-model/image01.png">

그리고 두 모델 모두 대화형 API 문서에 사용됩니다:

<img src="/img/tutorial/response-model/image02.png">

## 응답 모델 인코딩 매개변수

응답 모델은 아래와 같이 기본값을 가질 수 있습니다:

{* ../../docs_src/response_model/tutorial004.py hl[11,13:14] *}

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Mon Nov 18 02:25:44 GMT 2024

- 7.9K bytes

- Click Count (0)

Search Options