-
-
Notifications
You must be signed in to change notification settings - Fork 6.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
🌐 Add Russian translation for docs/ru/docs/tutorial/response-model.md
#9675
Conversation
📝 Docs preview for commit 1ad46b6 at: https://6489918cc356c5078c7143d3--fastapi.netlify.app |
📝 Docs preview for commit cb8277b at: https://6489a1b7cb6e8811f92dc3e4--fastapi.netlify.app |
FastAPI будет использовать этот возвращаемый тип для: | ||
|
||
* **Валидации** ответа. | ||
* Если данные невалидны (например, отсутствует одно из полей), это означает, что код *вашего* приложения работает некорректно и функция возвращает не 8000 то, что вы ожидаете. В таком случае приложение вернет server error вместо того, чтобы отправить неправильные данные. Таким образом, вы и ваши пользователи могут быть уверены, что получат корректные данные в том виде, в котором их ожидают. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Если данные невалидны (например, отсутствует одно из полей), это означает, что код *вашего* приложения работает некорректно и функция возвращает не то, что вы ожидаете. В таком случае приложение вернет server error вместо того, чтобы отправить неправильные данные. Таким образом, вы и ваши пользователи могут быть уверены, что получат корректные данные в том виде, в котором их ожидают. | |
* Если данные введены некорректно (например, отсутствует одно из полей), это означает, что код *вашего* приложения не работает и функция не возвращает то, что должна. В таком случае приложение вернет серверную ошибку, вместо возврата неправильных данных. Таким образом, вы и ваши пользователи могут быть уверены, что получат корректные данные в том виде, в котором их ожидают. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Мне кажется тут на вкус и цвет все фломастеры разные, но все же)
"* Если данные введены некорректно ..."
Здесь речь идет о том, что приложение возвращает какие то данные и именно эти данные валидируются. Это не данные которые кто-либо ввел - это будет результат работы приложения. слово "введены" может кого-нибудь запутать)
Насчет слова валиден - в wiki-словаре есть такое слово)) но спорить здесь не готов, если есть более подходящее слово
"... код вашего приложения не работает ..."
Мне кажется, так не совсем правильно по смыслу. Потому что код работает, т.е. не падает с ошибкой. Но работает не корректно, т.к. валидация ответа не прошла
" ... серверную ошибку ..."
мое мнение, что server error будет более понятно пользователю, чем серверная ошибка). Или хотя-бы просто ошибка написать. но здесь тоже спорить не готов, не принципиальный момент)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Author
Я не против слова невалидны, но забавно что снизу вам не нравится операции пути.
"Здесь речь идет о том, что приложение возвращает какие то данные"
Да, но у вас "вместо того, чтобы отправить неправильные данные", что я и исправил на возврат.
"... код вашего приложения не работает ..."
"Мне кажется, так не совсем правильно по смыслу."
Я не эту тему не собираюсь спорить, просто увидел что в оригинале как раз смысл другой, и валидация как раз проходит(иначе падала бы с ошибкой 422, поэтому кстати я и исправил слово валидация на 'не корректные данные', ибо в оригинале в других главах есть валидация данных и упоминается в другом контексте.)
fixed mismatches Co-authored-by: Alexandr <alexandrhub@vk.com>
📝 Docs preview for commit 40c1afe at: https://648c2ed97897085123307603--fastapi.netlify.app |
``` | ||
|
||
!!! note | ||
Помните, что параметр `response_model` является параметром именно декоратора http-методов (`get`, `post`, и т.п.). Не следует его указывать для *функций операций пути (path operation)*, как вы бы поступили с другими параметрами или с телом запроса. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Помните, что параметр `response_model` является параметром именно декоратора http-методов (`get`, `post`, и т.п.). Не следует его указывать для *функций операций пути (path operation)*, как вы бы поступили с другими параметрами или с телом запроса. | |
Помните, что параметр `response_model` является параметром именно декоратора http-методов (`get`, `post`, и т.п.), а не для вашей *функции операции пути*, как остальные параметры и тело запроса. |
|
||
`response_model` принимает те же типы, которые можно указать для какого-либо поля в модели Pydantic. Таким образом, это может быть как одиночная модель Pydantic, так и `список (list)` моделей Pydantic. Например, `List[Item]`. | ||
|
||
FastAPI будет использовать значение `response_model` для того, чтобы автоматически генерировать документацию, производить валидацию и т.п. А также для **конвертации и фильтрации выходных данных** в объявленный тип. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FastAPI будет использовать значение `response_model` для того, чтобы автоматически генерировать документацию, производить валидацию и т.п. А также для **конвертации и фильтрации выходных данных** в объявленный тип. | |
FastAPI будет использовать значение `response_model` для того, чтобы автоматически генерировать документацию, производить валидацию и т.п. А также для **конвертации и фильтрации выходных данных** в объявленный тип данных. |
|
||
В данном случае это не такая уж большая проблема, поскольку ответ получит тот же самый пользователь, который и создал пароль. | ||
|
||
Но что если мы захотим использовать эту модель для какой-либо другой *операции пути (path operation)*? Мы можем, сами того не желая, отправить пароль любому другому пользователю. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Но что если мы захотим использовать эту модель для какой-либо другой *операции пути (path operation)*? Мы можем, сами того не желая, отправить пароль любому другому пользователю. | |
Но что если мы захотим использовать эту модель для какой-либо другой *операции пути*? Мы можем, сами того не желая, отправить пароли наших пользователей всем клиентам. |
|
||
## Создадим модель для ответа | ||
|
||
Вместо этого мы можем создать входную модель, хранящую пароль в открытом виде и выходную модель без пароля: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Вместо этого мы можем создать входную модель, хранящую пароль в открытом виде и выходную модель без пароля: | |
Вместо этого мы можем создать модель для ввода данных, хранящую пароль в открытом виде и модель для вывода данных без пароля: |
Co-authored-by: ivan-abc <36765187+ivan-abc@users.noreply.github.com>
Co-authored-by: ivan-abc <36765187+ivan-abc@users.noreply.github.com>
📝 Docs preview for commit e8137f6 at: https://648c39c1546bc455bcbe061a--fastapi.netlify.app |
Co-authored-by: ivan-abc <36765187+ivan-abc@users.noreply.github.com>
📝 Docs preview for commit 481e482 at: https://648c3d3362aae25b60aaa027--fastapi.netlify.app |
Co-authored-by: Alexandr <alexandrhub@vk.com>
Co-authored-by: ivan-abc <36765187+ivan-abc@users.noreply.github.com>
Co-authored-by: ivan-abc <36765187+ivan-abc@users.noreply.github.com>
📝 Docs preview for commit 6aabbb6 at: https://648c41322c8d36602e0da830--fastapi.netlify.app |
📝 Docs preview for commit 7e008fb at: https://64905a8944734c66b54f1453--fastapi.netlify.app |
📝 Docs preview for commit 3159e9f at: https://64905c2c44734c676c4f14dd--fastapi.netlify.app |
📝 Docs preview for commit aa88caf at: https://64905d8e72e8806ce36e030c--fastapi.netlify.app |
📝 Docs preview for commit 410e5a4 at: https://649472f6b121c94bf1ab2b91--fastapi.netlify.app |
📝 Docs preview for commit 55b6d62 at: https://649a3167b8e96720081c1f8a--fastapi.netlify.app |
docs/ru/docs/tutorial/response-model.md
Awesome, thanks @glsglsgls! 🚀 And thanks for the reviews @ivan-abc and @Alexandrhub 🙇 ☕ |
No description provided.