diff --git a/docs/zh/docs/how-to/general.md b/docs/zh/docs/how-to/general.md new file mode 100644 index 0000000000..81aa14b091 --- /dev/null +++ b/docs/zh/docs/how-to/general.md @@ -0,0 +1,39 @@ +# 常规 - 如何操作 - 秘诀 + +对于常见或时常碰到的问题,这里有几个指向文档中其他地方的提示。 + +## 过滤数据 - 安全 + +为了确保您不会返回超过您应该返回的数据,请阅读文档 [教程 - 响应模型 - 返回类型](../tutorial/response-model.md){.internal-link target=_blank}。 + +## 文档标签 - OpenAPI + +为了将标签添加到您的 *路径操作*,并在文档界面中对其进行分组,请阅读文档 [教程 - 路径操作配置 - 标签](../tutorial/path-operation-configuration.md#tags){.internal-link target=_blank}。 + +## 文档摘要和描述 - OpenAPI + +需要为您的 *路径操作* 添加摘要和描述,并在文档界面中显示他们,请阅读文档 [教程 - 路径操作配置 - 摘要和说明](../tutorial/path-operation-configuration.md#summary-and-description){.internal-link target=_blank}。 + +## 文档响应描述 - OpenAPI + +需要定义文档界面中显示的响应描述,请阅读文档 [教程 - 路径操作配置 - 响应描述](../tutorial/path-operation-configuration.md#response-description){.internal-link target=_blank}。 + +## 文档废弃 *路径操作* - OpenAPI + +需要弃用 *路径操作*,并将其显示在文档界面中,请阅读文档 [教程 - 路径操作配置 - 废弃](../tutorial/path-operation-configuration.md#deprecate-a-path-operation){.internal-link target=_blank}。 + +## 将任何数据转换为与JSON兼容 + +为了将任何数据转换为与JSON兼容,请阅读文档 [教程 - JSON兼容编码器](../tutorial/encoder.md){.internal-link target=_blank}。 + +## OpenAPI元数据 - 文档 + +为了将元数据添加到您的OpenAPI模式中,包括许可证、版本、联系人等等,请阅读文档 [教程 - 元数据和文档URLs](../tutorial/metadata.md){.internal-link target=_blank}。 + +## OpenAPI自定义URL + +需要自定义(或删除)OpenAPI URL,请阅读文档 [教程 - 元数据和文档URLs](../tutorial/metadata.md#openapi-url){.internal-link target=_blank}。 + +## OpenAPI文档URLs + +需要更新自动生成的文档界面URLs, 请阅读文档 [教程 - 元数据和文档URLs](../tutorial/metadata.md#docs-urls){.internal-link target=_blank}。