|
31 | 31 | {!> ../../../docs_src/path_operation_configuration/tutorial001.py!} |
32 | 32 | ``` |
33 | 33 |
|
34 | | -Этот код состояния будет использован в ответе, и будет добавлен в схему OpenAPI. |
| 34 | +Этот код состояния будет использован в ответе и будет добавлен в схему OpenAPI. |
35 | 35 |
|
36 | 36 | !!! note "Технические детали" |
37 | 37 | Вы также можете использовать `from starlette import status`. |
38 | 38 |
|
39 | | - **FastAPI** предоставляет тот же `starlette.status`, что и `fastapi.status` для удобства разработчкиа. Но идет он непросредственно от Starlette. |
| 39 | + **FastAPI** предоставляет тот же `starlette.status` под псевдонимом `fastapi.status` для удобства разработчика. Но его источник - это непосредственно Starlette. |
40 | 40 |
|
41 | 41 | ## Теги |
42 | 42 |
|
|
66 | 66 |
|
67 | 67 | ### Теги с перечислениями |
68 | 68 |
|
69 | | -Если у вас большое приложение, под конец вы можете набрать **несколько тегов**, и вы можете хотеть убедиться в том, что всегда используете **один и тот же тег** для связанных *операций пути*. |
| 69 | +Если у вас большое приложение, вы можете прийти к необходимости добавить **несколько тегов**, и возможно, вы захотите убедиться в том, что всегда используете **один и тот же тег** для связанных *операций пути*. |
70 | 70 |
|
71 | | -В этих случаях, имеет смысл хранить теги в `Enum`. |
| 71 | +В этих случаях, имеет смысл хранить теги в классе `Enum`. |
72 | 72 |
|
73 | | -**FastAPI** поддерживает это также, как и с обычными строками: |
| 73 | +**FastAPI** поддерживает это так же, как и в случае с обычными строками: |
74 | 74 |
|
75 | 75 | ```Python hl_lines="1 8-10 13 18" |
76 | 76 | {!../../../docs_src/path_operation_configuration/tutorial002b.py!} |
77 | 77 | ``` |
78 | 78 |
|
79 | 79 | ## Краткое и развёрнутое содержание |
80 | 80 |
|
81 | | -Вы можете добавить `summary` и `description`: |
| 81 | +Вы можете добавить параметры `summary` и `description`: |
82 | 82 |
|
83 | 83 | === "Python 3.10+" |
84 | 84 |
|
|
100 | 100 |
|
101 | 101 | ## Описание из строк документации |
102 | 102 |
|
103 | | -Так как описания обычно длинные и содержат много строк, вы можете объявить описание *операции пути* в функции <abbr title="многострочный текст в качестве первого выражения внутри функции (не присвоенная какой-либо переменной), используемый для документации">строки документации</abbr> и **FastAPI** прочитает её отсюда. |
| 103 | +Так как описания обычно длинные и содержат много строк, вы можете объявить описание *операции пути* в функции <abbr title="многострочный текст, первое выражение внутри функции (не присвоенный какой-либо переменной), используемый для документации">строки документации</abbr> и **FastAPI** прочитает её отсюда. |
104 | 104 |
|
105 | | -Вы можете использовать <a href="https://en.wikipedia.org/wiki/Markdown" class="external-link" target="_blank">Markdown</a> в строке документации, и оно будет интерпретировано и отображено корректно (с учетом отступа в строке документации). |
| 105 | +Вы можете использовать <a href="https://en.wikipedia.org/wiki/Markdown" class="external-link" target="_blank">Markdown</a> в строке документации, и он будет интерпретирован и отображён корректно (с учетом отступа в строке документации). |
106 | 106 |
|
107 | 107 | === "Python 3.10+" |
108 | 108 |
|
|
149 | 149 | ``` |
150 | 150 |
|
151 | 151 | !!! info "Дополнительная информация" |
152 | | - Помните, что `response_description` относится конкретно к ответу, а `description` в основном относится к *операциям пути*. |
| 152 | + Помните, что `response_description` относится конкретно к ответу, а `description` относится к *операции пути* в целом. |
153 | 153 |
|
154 | 154 | !!! check "Технические детали" |
155 | 155 | OpenAPI указывает, что каждой *операции пути* необходимо описание ответа. |
156 | 156 |
|
157 | | - Если вдруг вы не укажите одно из них, то **FastAPI** автоматически сгенерирует один из "Удачных ответов". |
| 157 | + Если вдруг вы не укажете его, то **FastAPI** автоматически сгенерирует это описание с текстом "Successful response". |
158 | 158 |
|
159 | 159 | <img src="/img/tutorial/path-operation-configuration/image03.png"> |
160 | 160 |
|
161 | 161 | ## Обозначение *операции пути* как устаревшей |
162 | 162 |
|
163 | | -Если вам необходимо пометить *операцию пути* как <abbr title="устаревшее, не рекомендовано к использованию">устаревшую</abbr>, но без её удаления, передайте параметр `deprecated`: |
| 163 | +Если вам необходимо пометить *операцию пути* как <abbr title="устаревшее, не рекомендовано к использованию">устаревшую</abbr>, при этом не удаляя её, передайте параметр `deprecated`: |
164 | 164 |
|
165 | 165 | ```Python hl_lines="16" |
166 | 166 | {!../../../docs_src/path_operation_configuration/tutorial006.py!} |
|
170 | 170 |
|
171 | 171 | <img src="/img/tutorial/path-operation-configuration/image04.png"> |
172 | 172 |
|
173 | | -Проверьте, как устаревшие и не-устаревшие *операции пути* будут выглядеть: |
| 173 | +Проверьте, как будут выглядеть устаревшие и не устаревшие *операции пути*: |
174 | 174 |
|
175 | 175 | <img src="/img/tutorial/path-operation-configuration/image05.png"> |
176 | 176 |
|
|
0 commit comments