From 410da16a142212fba4e90dc35f92f1d5ef5ffa52 Mon Sep 17 00:00:00 2001
From: Ikkyu <31848542+RunningIkkyu@users.noreply.github.com>
Date: Thu, 26 Nov 2020 01:11:59 +0800
Subject: [PATCH] =?UTF-8?q?=F0=9F=8C=90=20Add=20Chinese=20translation=20fo?=
 =?UTF-8?q?r=20Advanced=20-=20Path=20Operation=20Advanced=20Configuration?=
 =?UTF-8?q?=20(#1447)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
---
 .../path-operation-advanced-configuration.md  | 53 +++++++++++++++++++
 docs/zh/mkdocs.yml                            |  1 +
 2 files changed, 54 insertions(+)
 create mode 100644 docs/zh/docs/advanced/path-operation-advanced-configuration.md

diff --git a/docs/zh/docs/advanced/path-operation-advanced-configuration.md b/docs/zh/docs/advanced/path-operation-advanced-configuration.md
new file mode 100644
index 000000000..7da9f251e
--- /dev/null
+++ b/docs/zh/docs/advanced/path-operation-advanced-configuration.md
@@ -0,0 +1,53 @@
+# 路径操作的高级配置
+
+## OpenAPI 的 operationId
+
+!!! warning
+    如果你并非 OpenAPI 的「专家」，你可能不需要这部分内容。
+
+你可以在路径操作中通过参数 `operation_id` 设置要使用的 OpenAPI `operationId`。
+
+务必确保每个操作路径的 `operation_id` 都是唯一的。
+
+```Python hl_lines="6"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial001.py!}
+```
+
+### 使用 *路径操作函数* 的函数名作为 operationId
+
+如果你想用你的 API 的函数名作为 `operationId` 的名字，你可以遍历一遍 API 的函数名，然后使用他们的 `APIRoute.name` 重写每个 *路径操作* 的 `operation_id`。
+
+你应该在添加了所有 *路径操作* 之后执行此操作。
+
+```Python hl_lines="2 12 13 14 15 16 17 18 19 20 21 24"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial002.py!}
+```
+
+!!! tip
+    如果你手动调用 `app.openapi()`，你应该在此之前更新 `operationId`。
+
+!!! warning
+    如果你这样做，务必确保你的每个 *路径操作函数* 的名字唯一。
+
+    即使它们在不同的模块中（Python 文件）。
+
+## 从 OpenAPI 中排除
+
+使用参数 `include_in_schema` 并将其设置为 `False` ，来从生成的 OpenAPI 方案中排除一个 *路径操作*（这样一来，就从自动化文档系统中排除掉了）。
+
+```Python hl_lines="6"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial003.py!}
+```
+
+## docstring 的高级描述
+
+你可以限制 *路径操作函数* 的 `docstring` 中用于 OpenAPI 的行数。
+
+添加一个 `\f` （一个「换页」的转义字符）可以使 **FastAPI** 在那一位置截断用于 OpenAPI 的输出。
+
+剩余部分不会出现在文档中，但是其他工具（比如 Sphinx）可以使用剩余部分。
+
+
+```Python hl_lines="19 20 21 22 23 24 25 26 27 28 29"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial004.py!}
+```
diff --git a/docs/zh/mkdocs.yml b/docs/zh/mkdocs.yml
index 3303ab6df..c57aae8cc 100644
--- a/docs/zh/mkdocs.yml
+++ b/docs/zh/mkdocs.yml
@@ -62,6 +62,7 @@ nav:
   - tutorial/body-fields.md
 - 高级用户指南:
   - advanced/index.md
+  - advanced/path-operation-advanced-configuration.md
 - deployment.md
 - contributing.md
 - help-fastapi.md