Compare commits

...

344 Commits

Author SHA1 Message Date
Sebastián Ramírez
f057f4a067 🔖 Release version 0.115.5 2024-11-12 17:14:23 +01:00
github-actions
c6f021ecc2 📝 Update release notes
[skip ci]
2024-11-12 16:12:19 +00:00
Sebastián Ramírez
91a929319c ♻️ Update internal checks to support Pydantic 2.10 (#12914) 2024-11-12 17:10:42 +01:00
github-actions
f716490823 📝 Update release notes
[skip ci]
2024-11-12 16:09:58 +00:00
Gaurav Sheni
c1781066be 📝 Update includes for docs/en/docs/tutorial/body.md (#12757)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-12 17:09:34 +01:00
github-actions
88cc900c83 📝 Update release notes
[skip ci]
2024-11-11 18:30:19 +00:00
pre-commit-ci[bot]
20809a175a ⬆ [pre-commit.ci] pre-commit autoupdate (#12907) 2024-11-11 18:29:56 +00:00
github-actions
5a48c37056 📝 Update release notes
[skip ci]
2024-11-10 17:41:44 +00:00
AyushSinghal1794
13892a39cd 📝 Update includes in docs/en/docs/advanced/testing-dependencies.md (#12647)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 17:40:22 +00:00
github-actions
9467000ad2 📝 Update release notes
[skip ci]
2024-11-10 17:39:14 +00:00
Nimitha J
694f6ccf0d 📝 Update includes for docs/en/docs/tutorial/metadata.md (#12773)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 17:38:49 +00:00
github-actions
f93a29542c 📝 Update release notes
[skip ci]
2024-11-10 17:37:08 +00:00
xuvjso
9aaeb8b057 📝 Update docs/en/docs/tutorial/dependencies/dependencies-with-yield.md (#12045)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 17:36:46 +00:00
github-actions
b32f612162 📝 Update release notes
[skip ci]
2024-11-10 17:28:13 +00:00
VISHNU V S
3829bdc4a5 📝 Update includes for docs/en/docs/tutorial/dependencies/global-dependencies.md (#12653)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 17:27:25 +00:00
github-actions
725fd16334 📝 Update release notes
[skip ci]
2024-11-10 17:26:22 +00:00
davioc
be516b0d2c 📝 Update includes for docs/en/docs/tutorial/body-updates.md (#12712)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 17:26:01 +00:00
github-actions
bfeecfc8c1 📝 Update release notes
[skip ci]
2024-11-10 17:23:59 +00:00
David Caro
bfaf4c303f 📝 Remove mention of Celery in the project generators (#12742)
Signed-off-by: David Caro <me@dcaro.es>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 17:23:38 +00:00
github-actions
cb53c5b918 📝 Update release notes
[skip ci]
2024-11-10 17:19:41 +00:00
Zhaohan Dong
8f5ec897f7 📝 Update includes in docs/en/docs/tutorial/header-param-models.md (#12814)
Signed-off-by: Zhaohan Dong <65422392+zhaohan-dong@users.noreply.github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 17:19:19 +00:00
github-actions
6cd050ceb6 📝 Update release notes
[skip ci]
2024-11-10 17:12:44 +00:00
Sebastián Ramírez
8767a31c80 📝 Update contributing.md docs, include note to not translate this page (#12841) 2024-11-10 17:11:56 +00:00
github-actions
290e1060ca 📝 Update release notes
[skip ci]
2024-11-10 17:11:35 +00:00
VISHNU V S
9fa2474be0 📝 Update includes in docs/en/docs/tutorial/request-forms.md (#12648)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 17:10:49 +00:00
github-actions
9e441510ba 📝 Update release notes
[skip ci]
2024-11-10 17:09:31 +00:00
VISHNU V S
821b32f8b3 📝 Update includes in docs/en/docs/tutorial/request-form-models.md (#12649)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 17:09:09 +00:00
github-actions
1d9d189b85 📝 Update release notes
[skip ci]
2024-11-10 17:03:36 +00:00
Okeke Chukwuemeka Christian
1fc9a9ad3a 📝 Update includes in docs/en/docs/tutorial/security/oauth2-jwt.md (#12650)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 17:02:51 +00:00
github-actions
65f512052c 📝 Update release notes
[skip ci]
2024-11-10 16:59:09 +00:00
Max Patalas
ba734c2312 📝 Update includes in docs/vi/docs/tutorial/first-steps.md (#12754)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 16:58:43 +00:00
github-actions
37a557a0a3 📝 Update release notes
[skip ci]
2024-11-10 16:56:41 +00:00
Nimitha J
be67605728 📝 Update includes for docs/pt/docs/advanced/wsgi.md (#12769)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 16:56:13 +00:00
github-actions
2d524cca14 📝 Update release notes
[skip ci]
2024-11-10 16:45:50 +00:00
Baldeep Singh Handa
b2236d080a 📝 Update includes for docs/en/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md (#12815)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-11-10 16:45:28 +00:00
github-actions
370f4f9980 📝 Update release notes
[skip ci]
2024-11-10 01:25:37 +00:00
Baldeep Singh Handa
a01f9f298e 📝 Update includes for docs/en/docs/tutorial/dependencies/classes-as-dependencies.md (#12813) 2024-11-10 01:11:07 +00:00
github-actions
df6d1de3e6 📝 Update release notes
[skip ci]
2024-11-09 20:14:12 +00:00
Sebastián Ramírez
98182d02ce 🔨 Update docs preview script to show previous version and English version (#12856) 2024-11-09 20:13:48 +00:00
github-actions
5d03558363 📝 Update release notes
[skip ci]
2024-11-09 17:07:31 +00:00
Alejandra
40912999d1 ✏️ Fix error in docs/en/docs/tutorial/middleware.md (#12819) 2024-11-09 17:07:05 +00:00
github-actions
5df1415fee 📝 Update release notes
[skip ci]
2024-11-09 17:04:00 +00:00
Okeke Chukwuemeka Christian
f26a1b6385 📝 Update includes for docs/en/docs/tutorial/security/get-current-user.md (#12645) 2024-11-09 17:03:01 +00:00
github-actions
f5b8f39ed7 📝 Update release notes
[skip ci]
2024-11-09 17:01:51 +00:00
Okeke Chukwuemeka Christian
6e7e6f6c55 📝 Update includes for docs/en/docs/tutorial/security/first-steps.md (#12643) 2024-11-09 16:59:54 +00:00
github-actions
a81662b3c1 📝 Update release notes
[skip ci]
2024-11-09 16:56:02 +00:00
Zhaohan Dong
aaab24205f 📝 Update includes in docs/de/docs/advanced/additional-responses.md (#12821) 2024-11-09 16:53:31 +00:00
github-actions
5d1cb40c5e 📝 Update release notes
[skip ci]
2024-11-09 16:52:39 +00:00
AyushSinghal1794
ac4956d3a3 📝 Update includes in docs/en/docs/advanced/generate-clients.md (#12642) 2024-11-09 16:52:15 +00:00
github-actions
d9119528ea 📝 Update release notes
[skip ci]
2024-11-09 16:41:55 +00:00
Sebastián Ramírez
7fb9c5922d 📝 Fix admonition double quotes with new syntax (#12835)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2024-11-09 16:39:20 +00:00
github-actions
d08c4cffab 📝 Update release notes
[skip ci]
2024-11-09 16:34:56 +00:00
Zhaohan Dong
e812f87276 📝 Update includes in docs/zh/docs/advanced/additional-responses.md (#12828) 2024-11-09 16:29:26 +00:00
github-actions
e5d00910d6 📝 Update release notes
[skip ci]
2024-11-09 16:28:06 +00:00
Zhaohan Dong
ac9f4517f0 📝 Update includes in docs/en/docs/tutorial/path-params-numeric-validations.md (#12825) 2024-11-09 16:25:01 +00:00
github-actions
5e21dddb93 📝 Update release notes
[skip ci]
2024-11-09 16:21:37 +00:00
Hamid Rasti
52e8ea4c97 📝 Update includes for docs/en/docs/advanced/testing-websockets.md (#12761) 2024-11-09 16:19:46 +00:00
github-actions
18ca10cee4 📝 Update release notes
[skip ci]
2024-11-09 16:19:17 +00:00
Hamid Rasti
2d45b54f10 📝 Update includes for docs/en/docs/advanced/using-request-directly.md (#12760) 2024-11-09 16:18:55 +00:00
github-actions
8a560758f8 📝 Update release notes
[skip ci]
2024-11-09 16:18:19 +00:00
Hamid Rasti
a86d2bbf4f 📝 Update includes for docs/advanced/wsgi.md (#12758) 2024-11-09 16:17:10 +00:00
github-actions
5a7bd20316 📝 Update release notes
[skip ci]
2024-11-09 16:16:22 +00:00
paintdog
5eec59fa4d 📝 Update includes in docs/de/docs/tutorial/middleware.md (#12729) 2024-11-09 16:15:51 +00:00
github-actions
aac7bbb51e 📝 Update release notes
[skip ci]
2024-11-09 16:00:40 +00:00
Sebastián Ramírez
5c080d81ae 📝 Update includes for docs/en/docs/tutorial/schema-extra-example.md (#12822) 2024-11-09 16:00:17 +00:00
github-actions
636171ce31 📝 Update release notes
[skip ci]
2024-11-09 15:49:07 +00:00
Fred
9a8a1adad3 📝 Update includes in docs/fr/docs/advanced/additional-responses.md (#12634) 2024-11-09 15:48:46 +00:00
github-actions
712c57393c 📝 Update release notes
[skip ci]
2024-11-09 15:43:28 +00:00
Quentin Takeda
2cfd018446 📝 Update includes in docs/fr/docs/advanced/path-operation-advanced-configuration.md (#12633) 2024-11-09 15:43:03 +00:00
github-actions
2e35557254 📝 Update release notes
[skip ci]
2024-11-09 15:39:04 +00:00
Quentin Takeda
5cf323d93c 📝 Update includes in docs/fr/docs/advanced/response-directly.md (#12632) 2024-11-09 15:38:03 +00:00
github-actions
911d24bede 📝 Update release notes
[skip ci]
2024-11-09 15:33:00 +00:00
VISHNU V S
438343c376 📝 Update includes for docs/en/docs/tutorial/header-params.md (#12640) 2024-11-09 15:32:39 +00:00
github-actions
182cc4439e 📝 Update release notes
[skip ci]
2024-11-09 15:30:31 +00:00
VISHNU V S
35506c1f59 📝 Update includes in docs/en/docs/tutorial/cookie-param-models.md (#12639) 2024-11-09 15:29:53 +00:00
github-actions
0c449748ff 📝 Update release notes
[skip ci]
2024-11-09 15:29:42 +00:00
VISHNU V S
480ba19e9f 📝 Update includes for docs/en/docs/tutorial/extra-models.md (#12638) 2024-11-09 15:28:48 +00:00
github-actions
825419ecc4 📝 Update release notes
[skip ci]
2024-11-09 15:27:18 +00:00
VISHNU V S
85e0a95bde 📝 Update includes for docs/en/docs/tutorial/cors.md (#12637) 2024-11-09 15:26:44 +00:00
github-actions
48c66e30db 📝 Update release notes
[skip ci]
2024-11-09 15:21:54 +00:00
Baldeep Singh Handa
747534334a 📝 Update includes for docs/en/docs/tutorial/dependencies/sub-dependencies.md (#12810) 2024-11-09 15:21:30 +00:00
github-actions
76b13045fe 📝 Update release notes
[skip ci]
2024-11-09 15:10:34 +00:00
Zhaohan Dong
069e9bdea8 📝 Update includes in docs/en/docs/tutorial/body-nested-models.md (#12812) 2024-11-09 15:10:11 +00:00
github-actions
4dcdb20151 📝 Update release notes
[skip ci]
2024-11-09 14:54:50 +00:00
Alex Wendland
f6819ba5d2 📝 Update includes in docs/en/docs/tutorial/path-operation-configuration.md (#12809) 2024-11-09 14:54:23 +00:00
github-actions
e474d042d3 📝 Update release notes
[skip ci]
2024-11-09 14:50:19 +00:00
Zhaohan Dong
170826c911 📝 Update includes in docs/en/docs/tutorial/request-files.md (#12818) 2024-11-09 14:49:21 +00:00
github-actions
9628d38d24 📝 Update release notes
[skip ci]
2024-11-09 14:47:48 +00:00
Baldeep Singh Handa
f6ba3a3c46 📝 Update includes for docs/en/docs/tutorial/query-param-models.md (#12817) 2024-11-09 14:47:24 +00:00
github-actions
e6b48c6451 📝 Update release notes
[skip ci]
2024-11-09 14:19:51 +00:00
Alex Wendland
6f671b8b5a 📝 Update includes in docs/en/docs/tutorial/path-params.md (#12811) 2024-11-09 14:19:27 +00:00
github-actions
23cb1f8334 📝 Update release notes
[skip ci]
2024-11-09 14:14:59 +00:00
Quentin Takeda
abd6ad2187 📝 Update includes in docs/en/docs/tutorial/response-model.md (#12621) 2024-11-09 14:13:47 +00:00
github-actions
f2b100900a 📝 Update release notes
[skip ci]
2024-11-09 13:25:30 +00:00
VISHNU V S
ffcb635c2a 📝 Update includes in docs/en/docs/advanced/websockets.md (#12606) 2024-11-09 13:25:07 +00:00
github-actions
64204dc2b1 📝 Update release notes
[skip ci]
2024-11-09 12:35:47 +00:00
Baldeep Singh Handa
5d62d85095 📝 Updates include for docs/en/docs/tutorial/cookie-params.md (#12808) 2024-11-09 12:32:45 +00:00
github-actions
3f2b4339aa 📝 Update release notes
[skip ci]
2024-11-09 12:27:28 +00:00
github-actions
3c914aa610 📝 Update release notes
[skip ci]
2024-11-09 12:25:28 +00:00
Alex Wendland
f0a8f00b41 📝 Update includes in docs/en/docs/tutorial/middleware.md (#12807) 2024-11-09 12:24:09 +00:00
github-actions
e364f941be 📝 Update release notes
[skip ci]
2024-11-09 12:23:03 +00:00
Zhaohan Dong
334d8326d0 📝 Update includes in docs/en/docs/advanced/sub-applications.md (#12806) 2024-11-09 12:21:25 +00:00
github-actions
589f3c0e59 📝 Update release notes
[skip ci]
2024-11-09 12:21:07 +00:00
Chol_rang
2abde61372 🌐 Add Korean translation for docs/ko/docs/advanced/testing-websockets.md (#12739) 2024-11-09 12:18:47 +00:00
史云昔 (Vincy SHI)
8b183f18f7 🌐 Add Traditional Chinese translation for docs/zh-hant/docs/environment-variables.md (#12785) 2024-11-09 12:17:55 +00:00
github-actions
b458d0acb5 📝 Update release notes
[skip ci]
2024-11-09 12:17:39 +00:00
史云昔 (Vincy SHI)
58eb4e4fc5 🌐 Add Chinese translation for docs/zh/docs/environment-variables.md (#12784) 2024-11-09 12:17:15 +00:00
github-actions
35c37be540 📝 Update release notes
[skip ci]
2024-11-09 12:15:34 +00:00
Zhaohan Dong
58975aa3ed 📝 Update includes in docs/en/docs/advanced/response-headers.md (#12805) 2024-11-09 12:14:09 +00:00
github-actions
62b318e585 📝 Update release notes
[skip ci]
2024-11-09 12:12:02 +00:00
Quentin Takeda
f55f93c181 📝 Update includes in docs/fr/docs/tutorial/first-steps.md (#12594)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2024-11-09 12:10:11 +00:00
github-actions
75cde1fb5c 📝 Update release notes
[skip ci]
2024-11-09 12:06:57 +00:00
Zhaohan Dong
854cddf1a8 📝 Update includes in docs/en/docs/advanced/response-cookies.md (#12804) 2024-11-09 12:06:35 +00:00
github-actions
f91d193d63 📝 Update release notes
[skip ci]
2024-11-09 11:58:33 +00:00
Zhaohan Dong
b5036db18c 📝 Update includes in docs/en/docs/advanced/path-operation-advanced-configuration.md (#12802) 2024-11-09 11:58:07 +00:00
github-actions
8fb3348889 📝 Update release notes
[skip ci]
2024-11-09 11:54:43 +00:00
Baldeep Singh Handa
22eafff2d8 📝 Update includes for docs/en/docs/advanced/response-directly.md (#12803) 2024-11-09 11:54:19 +00:00
github-actions
835123ee28 📝 Update release notes
[skip ci]
2024-11-09 11:50:20 +00:00
Zhaohan Dong
5e0722276a 📝 Update includes in docs/zh/docs/tutorial/background-tasks.md (#12798) 2024-11-09 11:49:55 +00:00
github-actions
a36454a7e6 📝 Update release notes
[skip ci]
2024-11-09 11:34:42 +00:00
Alissa
c88e82d6ec 📝 Update includes for docs/de/docs/tutorial/body-multiple-params.md (#12699) 2024-11-09 11:32:51 +00:00
github-actions
6b965b576e 📝 Update release notes
[skip ci]
2024-11-09 11:31:19 +00:00
Alex Wendland
34ed88394c 📝 Update includes in docs/em/docs/tutorial/body-updates.md (#12799) 2024-11-09 11:27:35 +00:00
github-actions
b2ec345e67 📝 Update release notes
[skip ci]
2024-11-09 11:25:26 +00:00
Baldeep Singh Handa
7517aa9f8f 📝 Update includes docs/en/docs/advanced/response-change-status-code.md (#12801) 2024-11-09 11:23:58 +00:00
github-actions
c0f56ce0b2 📝 Update release notes
[skip ci]
2024-11-09 11:23:32 +00:00
Baldeep Singh Handa
2d4e9d46c0 📝 Update includes docs/en/docs/advanced/openapi-callbacks.md (#12800) 2024-11-09 11:23:09 +00:00
github-actions
38141dbc9f 📝 Update release notes
[skip ci]
2024-11-09 11:12:50 +00:00
Quentin Takeda
150f8225b2 📝 Update includes in docs/fr/docs/tutorial/body-multiple-params.md (#12598) 2024-11-09 11:10:17 +00:00
github-actions
c1110d529e 📝 Update release notes
[skip ci]
2024-11-09 11:08:32 +00:00
Tashanam Shahbaz
83d7f11405 📝 Update includes in docs/en/docs/tutorial/body-multiple-params.md (#12593) 2024-11-09 11:08:12 +00:00
github-actions
6d066c0d62 📝 Update release notes
[skip ci]
2024-11-09 10:56:01 +00:00
Félix
5b2bd906d7 📝 Update includes in docs/pt/docs/tutorial/background-tasks.md (#12736) 2024-11-09 10:55:35 +00:00
github-actions
4733cc7486 📝 Update release notes
[skip ci]
2024-11-09 10:44:54 +00:00
Baldeep Singh Handa
1cfd9a70ac 📝 Update includes for docs/en/docs/advanced/custom-response.md (#12797) 2024-11-09 10:44:28 +00:00
github-actions
92a5f68e4d 📝 Update release notes
[skip ci]
2024-11-09 10:33:21 +00:00
Rafael de Oliveira Marques
51fe0e437b 📝 Update includes for docs/pt/docs/python-types.md (#12671) 2024-11-09 10:32:53 +00:00
github-actions
ce97de97d9 📝 Update release notes
[skip ci]
2024-11-09 10:16:07 +00:00
Alissa
890a61fb67 📝 Update includes for docs/de/docs/python-types.md (#12660) 2024-11-09 10:15:47 +00:00
github-actions
546bb50e09 📝 Update release notes
[skip ci]
2024-11-09 10:12:55 +00:00
Alissa
af280dbde9 📝 Update includes for docs/de/docs/advanced/dataclasses.md (#12658) 2024-11-09 10:12:35 +00:00
github-actions
ee260368d0 📝 Update release notes
[skip ci]
2024-11-09 10:08:49 +00:00
Quentin Takeda
1e9ea61cbd 📝 Update includes in docs/fr/docs/tutorial/path-params.md (#12592) 2024-11-09 10:08:25 +00:00
github-actions
5618035203 📝 Update release notes
[skip ci]
2024-11-09 10:02:55 +00:00
Alissa
855b4f66f5 📝 Update includes for docs/de/docs/how-to/configure-swagger-ui.md (#12690) 2024-11-09 10:02:30 +00:00
github-actions
858912e6e4 📝 Update release notes
[skip ci]
2024-11-08 22:06:00 +00:00
dependabot[bot]
8cd47a3551 ⬆ Bump tiangolo/latest-changes from 0.3.1 to 0.3.2 (#12794)
Bumps [tiangolo/latest-changes](https://github.com/tiangolo/latest-changes) from 0.3.1 to 0.3.2.
- [Release notes](https://github.com/tiangolo/latest-changes/releases)
- [Commits](https://github.com/tiangolo/latest-changes/compare/0.3.1...0.3.2)

---
updated-dependencies:
- dependency-name: tiangolo/latest-changes
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-11-08 22:05:33 +00:00
github-actions
b0fe5ebbf0 📝 Update release notes 2024-11-08 19:42:52 +00:00
LKY
075f41bad9 🌐 Add Korean translation for ko/docs/advanced/response-headers.md (#12740) 2024-11-08 19:42:29 +00:00
github-actions
4f430f49ac 📝 Update release notes 2024-11-08 19:23:51 +00:00
史云昔 (Vincy SHI)
45d9fabbdd 🌐 Add Chinese translation for docs/zh/docs/virtual-environments.md (#12790) 2024-11-08 19:23:26 +00:00
github-actions
2809c08a70 📝 Update release notes 2024-11-07 21:05:45 +00:00
Hyunjun KIM
d28bae06e4 🌐 Add Korean translation for /docs/ko/docs/environment-variables.md (#12526) 2024-11-07 20:57:27 +00:00
github-actions
647a0dcad3 📝 Update release notes 2024-11-07 20:52:31 +00:00
github-actions
3ff6cfd544 📝 Update release notes 2024-11-07 20:48:35 +00:00
Saeye Lee
745c073a6b 🌐 Add Korean translation for docs/ko/docs/history-design-future.md (#12646) 2024-11-07 20:46:14 +00:00
github-actions
1b8030945f 📝 Update release notes 2024-11-07 20:45:49 +00:00
kim-sangah
321053bdef 🌐 Add Korean translation for docs/ko/docs/advanced/advanced-dependencies.md (#12675) 2024-11-07 20:43:46 +00:00
github-actions
4565466f34 📝 Update release notes 2024-11-07 20:43:27 +00:00
sptcnl
2fcae5f108 🌐 Add Korean translation for docs/ko/docs/how-to/conditional-openapi.md (#12731) 2024-11-07 20:41:38 +00:00
LKY
c5ff950dfc 🌐 Add Korean translation for docs/ko/docs/advanced/using_request_directly.md (#12738) 2024-11-07 20:40:19 +00:00
github-actions
b3d3f0e723 📝 Update release notes 2024-11-07 20:39:11 +00:00
github-actions
3a2ec11e80 📝 Update release notes 2024-11-07 20:38:47 +00:00
namjimin_43
569c54cb9a 🌐 Add Korean translation for docs/ko/docs/advanced/testing-events.md (#12741) 2024-11-07 20:38:31 +00:00
kim-sangah
23c3522467 🌐 Add Korean translation for docs/ko/docs/security/index.md (#12743) 2024-11-07 20:38:25 +00:00
github-actions
f2c7b87721 📝 Update release notes 2024-11-07 20:32:59 +00:00
dependabot[bot]
731c85a876 ⬆ Bump pypa/gh-action-pypi-publish from 1.12.0 to 1.12.2 (#12788)
Bumps [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) from 1.12.0 to 1.12.2.
- [Release notes](https://github.com/pypa/gh-action-pypi-publish/releases)
- [Commits](https://github.com/pypa/gh-action-pypi-publish/compare/v1.12.0...v1.12.2)

---
updated-dependencies:
- dependency-name: pypa/gh-action-pypi-publish
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-11-07 20:32:35 +00:00
github-actions
0c7296b19e 📝 Update release notes 2024-11-06 18:24:11 +00:00
João Pedro Pereira Holanda
d0e0b27f73 🌐 Add Portuguese translation for docs/pt/docs/advanced/path-operation-advanced-configuration.md (#12762) 2024-11-06 18:21:50 +00:00
github-actions
845a2ecd39 📝 Update release notes 2024-11-06 18:17:40 +00:00
github-actions
45579ad78c 📝 Update release notes 2024-11-06 18:15:59 +00:00
dependabot[bot]
c8bcb633cc ⬆ Bump pypa/gh-action-pypi-publish from 1.11.0 to 1.12.0 (#12781)
Bumps [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) from 1.11.0 to 1.12.0.
- [Release notes](https://github.com/pypa/gh-action-pypi-publish/releases)
- [Commits](https://github.com/pypa/gh-action-pypi-publish/compare/v1.11.0...v1.12.0)

---
updated-dependencies:
- dependency-name: pypa/gh-action-pypi-publish
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-11-06 18:15:30 +00:00
github-actions
4d3e1cd22a 📝 Update release notes 2024-11-06 18:15:17 +00:00
dependabot[bot]
7eda7e28a6 ⬆ Bump cloudflare/wrangler-action from 3.11 to 3.12 (#12777)
Bumps [cloudflare/wrangler-action](https://github.com/cloudflare/wrangler-action) from 3.11 to 3.12.
- [Release notes](https://github.com/cloudflare/wrangler-action/releases)
- [Changelog](https://github.com/cloudflare/wrangler-action/blob/main/CHANGELOG.md)
- [Commits](https://github.com/cloudflare/wrangler-action/compare/v3.11...v3.12)

---
updated-dependencies:
- dependency-name: cloudflare/wrangler-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-11-06 18:15:12 +00:00
pre-commit-ci[bot]
3ff4da5387 ⬆ [pre-commit.ci] pre-commit autoupdate (#12766)
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.7.1 → v0.7.2](https://github.com/astral-sh/ruff-pre-commit/compare/v0.7.1...v0.7.2)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2024-11-06 18:14:55 +00:00
github-actions
d4ab06a2b6 📝 Update release notes 2024-11-01 11:25:57 +00:00
github-actions
3739999b76 📝 Update release notes 2024-11-01 11:21:54 +00:00
github-actions
eba967c65a 📝 Update release notes 2024-11-01 11:20:24 +00:00
dependabot[bot]
1f15034638 ⬆ Bump pypa/gh-action-pypi-publish from 1.10.3 to 1.11.0 (#12721)
Bumps [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) from 1.10.3 to 1.11.0.
- [Release notes](https://github.com/pypa/gh-action-pypi-publish/releases)
- [Commits](https://github.com/pypa/gh-action-pypi-publish/compare/v1.10.3...v1.11.0)

---
updated-dependencies:
- dependency-name: pypa/gh-action-pypi-publish
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-11-01 11:19:50 +00:00
github-actions
6670e8af68 📝 Update release notes 2024-11-01 11:18:59 +00:00
dependabot[bot]
fd40d00748 ⬆ Update pre-commit requirement from <4.0.0,>=2.17.0 to >=2.17.0,<5.0.0 (#12749)
Updates the requirements on [pre-commit](https://github.com/pre-commit/pre-commit) to permit the latest version.
- [Release notes](https://github.com/pre-commit/pre-commit/releases)
- [Changelog](https://github.com/pre-commit/pre-commit/blob/main/CHANGELOG.md)
- [Commits](https://github.com/pre-commit/pre-commit/compare/v2.17.0...v4.0.1)

---
updated-dependencies:
- dependency-name: pre-commit
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-11-01 11:17:36 +00:00
github-actions
70f50442d9 📝 Update release notes 2024-11-01 11:17:26 +00:00
dependabot[bot]
54fa592dac ⬆ Bump typer from 0.12.3 to 0.12.5 (#12748)
Bumps [typer](https://github.com/fastapi/typer) from 0.12.3 to 0.12.5.
- [Release notes](https://github.com/fastapi/typer/releases)
- [Changelog](https://github.com/fastapi/typer/blob/master/docs/release-notes.md)
- [Commits](https://github.com/fastapi/typer/compare/0.12.3...0.12.5)

---
updated-dependencies:
- dependency-name: typer
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-11-01 11:17:22 +00:00
dependabot[bot]
fd98edcdd5 ⬆ Update flask requirement from <3.0.0,>=1.1.2 to >=1.1.2,<4.0.0 (#12747)
Updates the requirements on [flask](https://github.com/pallets/flask) to permit the latest version.
- [Release notes](https://github.com/pallets/flask/releases)
- [Changelog](https://github.com/pallets/flask/blob/main/CHANGES.rst)
- [Commits](https://github.com/pallets/flask/compare/1.1.2...3.0.3)

---
updated-dependencies:
- dependency-name: flask
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-11-01 11:17:12 +00:00
github-actions
c4a2201a6b 📝 Update release notes 2024-11-01 11:16:58 +00:00
dependabot[bot]
4695b8d07f ⬆ Bump pillow from 10.4.0 to 11.0.0 (#12746)
Bumps [pillow](https://github.com/python-pillow/Pillow) from 10.4.0 to 11.0.0.
- [Release notes](https://github.com/python-pillow/Pillow/releases)
- [Changelog](https://github.com/python-pillow/Pillow/blob/main/CHANGES.rst)
- [Commits](https://github.com/python-pillow/Pillow/compare/10.4.0...11.0.0)

---
updated-dependencies:
- dependency-name: pillow
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-11-01 11:16:55 +00:00
dependabot[bot]
808196f2a3 ⬆ Update pytest requirement from <8.0.0,>=7.1.3 to >=7.1.3,<9.0.0 (#12745)
Updates the requirements on [pytest](https://github.com/pytest-dev/pytest) to permit the latest version.
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pytest-dev/pytest/compare/7.1.3...8.3.3)

---
updated-dependencies:
- dependency-name: pytest
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-11-01 11:16:34 +00:00
github-actions
a18ab76322 📝 Update release notes 2024-10-31 18:56:59 +00:00
Chol_rang
14b087cd36 🌐 Add Korean translation for docs/ko/docs/advanced/wsgi.md (#12659) 2024-10-31 18:56:37 +00:00
github-actions
42c002e4ec 📝 Update release notes 2024-10-31 12:21:22 +00:00
Fernando Alzueta
b7102a2675 🌐 Add Portuguese translation for docs/pt/docs/advanced/websockets.md (#12703) 2024-10-31 12:20:59 +00:00
github-actions
868720a798 📝 Update release notes 2024-10-31 12:18:10 +00:00
Lídia
bb7921be25 🌐 Add Portuguese translation for docs/pt/docs/tutorial/security/simple-oauth2.md (#12520) 2024-10-31 12:17:45 +00:00
github-actions
086e3ca54b 📝 Update release notes 2024-10-31 09:13:53 +00:00
Sebastián Ramírez
05c8ed3312 🔧 Update sponsors: add Render (#12733) 2024-10-31 09:13:26 +00:00
github-actions
bf83889844 📝 Update release notes 2024-10-30 20:02:57 +00:00
github-actions
2f7a860ee0 📝 Update release notes 2024-10-30 20:02:34 +00:00
namjimin_43
e93b27452b 🌐 Add Korean translation for docs/ko/docs/advanced/response-directly.md (#12674) 2024-10-30 20:00:57 +00:00
Luis Rodrigues
3184b5c701 🌐 Add Portuguese translation for docs/pt/docs/advanced/middleware.md (#12704) 2024-10-30 20:00:22 +00:00
github-actions
067ec21580 📝 Update release notes 2024-10-30 19:54:20 +00:00
Fernando Alzueta
5be5ea92c0 🌐 Add Portuguese translation for docs/pt/docs/advanced/openapi-callbacks.md (#12705) 2024-10-30 19:53:03 +00:00
github-actions
872feaccbe 📝 Update release notes 2024-10-30 19:52:53 +00:00
Luis Rodrigues
ece28bc8db 🌐 Add Portuguese translation for docs/pt/docs/tutorial/request-files.md (#12706) 2024-10-30 19:52:32 +00:00
github-actions
8dc523b1ef 📝 Update release notes 2024-10-29 11:47:36 +00:00
João Pedro Pereira Holanda
c5a9d3ac28 🌐 Add Portuguese Translation for docs/pt/docs/advanced/custom-response.md (#12631) 2024-10-29 11:47:10 +00:00
github-actions
25c63800f6 📝 Update release notes 2024-10-29 11:02:39 +00:00
Krishna Madhavan
268eac9e16 📝 Update includes in docs/en/docs/advanced/security/oauth2-scopes.md (#12572) 2024-10-29 11:02:16 +00:00
github-actions
c8f5755d0a 📝 Update release notes 2024-10-29 10:39:18 +00:00
github-actions
8cae611101 📝 Update release notes 2024-10-29 10:36:58 +00:00
Lincoln Melo
6e07910cc4 🌐 Add Portuguese translation for docs/pt/docs/tutorial/metadata.md (#12538) 2024-10-29 10:36:14 +00:00
LKY
46a085ebe7 🌐 Add Korean translation for docs/ko/docs/tutorial/metadata.md (#12541) 2024-10-29 10:36:06 +00:00
github-actions
3f3637ba73 📝 Update release notes 2024-10-29 10:33:16 +00:00
kim-sangah
3f822818b2 🌐 Add Korean Translation for docs/ko/docs/advanced/response-cookies.md (#12546) 2024-10-29 10:32:45 +00:00
github-actions
e1d724ab92 📝 Update release notes 2024-10-28 20:32:12 +00:00
pre-commit-ci[bot]
93bf4c9c2d ⬆ [pre-commit.ci] pre-commit autoupdate (#12707)
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.7.0 → v0.7.1](https://github.com/astral-sh/ruff-pre-commit/compare/v0.7.0...v0.7.1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2024-10-28 20:31:44 +00:00
github-actions
8669a92dac 📝 Update release notes 2024-10-28 11:31:18 +00:00
김소연
5c33269419 🌐 Add Korean translation for docs/ko/docs/fastapi-cli.md (#12515) 2024-10-28 11:29:32 +00:00
github-actions
f2b633ebee 📝 Update release notes 2024-10-28 11:24:36 +00:00
Rabin Lama Dong
ec9976f7a6 📝 Update includes for docs/en/docs/how-to/conditional-openapi.md (#12624) 2024-10-28 11:21:54 +00:00
github-actions
38bb9f934b 📝 Update release notes 2024-10-28 11:19:26 +00:00
Abdul Hadi Bharara
cb2c56008d 📝 Update includes in docs/en/docs/tutorial/dependencies/index.md (#12615) 2024-10-28 11:18:17 +00:00
github-actions
efb99a2bb4 📝 Update release notes 2024-10-28 11:13:38 +00:00
Quentin Takeda
26702a6525 📝 Update includes in docs/en/docs/tutorial/response-status-code.md (#12620) 2024-10-28 11:13:18 +00:00
github-actions
f6a6366e42 📝 Update release notes 2024-10-28 10:50:28 +00:00
github-actions
70869200bd 📝 Update release notes 2024-10-28 10:42:48 +00:00
Rabin Lama Dong
86d8e729c8 📝 Update includes for docs/en/docs/how-to/custom-docs-ui-assets.md (#12623) 2024-10-28 10:42:34 +00:00
github-actions
794d4b3a9b 📝 Update release notes 2024-10-28 10:39:28 +00:00
Mohamed Salman
8a4652d8b4 📝 Update includes in docs/en/docs/advanced/openapi-webhooks.md (#12605) 2024-10-28 10:38:23 +00:00
github-actions
3ea198f23c 📝 Update release notes 2024-10-28 10:37:16 +00:00
Mohamed Salman
2bd2ccbd19 📝 Update includes in docs/en/docs/advanced/events.md (#12604) 2024-10-28 10:36:22 +00:00
github-actions
bcd55f8c09 📝 Update release notes 2024-10-28 10:35:33 +00:00
Mohamed Salman
76126c45e7 📝 Update includes in docs/en/docs/advanced/dataclasses.md (#12603) 2024-10-28 10:35:06 +00:00
github-actions
fe3922311f 📝 Update release notes 2024-10-28 10:34:51 +00:00
Antony Arévalo
96c5566a5b 📝 Update includes in docs/es/docs/tutorial/cookie-params.md (#12602) 2024-10-28 10:33:43 +00:00
Quentin Takeda
218d3c3524 📝 Update includes in docs/fr/docs/tutorial/path-params-numeric-validations.md (#12601) 2024-10-28 10:32:37 +00:00
github-actions
0279f6dd5f 📝 Update release notes 2024-10-28 10:30:19 +00:00
Quentin Takeda
269a224544 📝 Update includes in docs/fr/docs/tutorial/background-tasks.md (#12600) 2024-10-28 10:29:51 +00:00
github-actions
adf89d1d9f 📝 Update release notes 2024-10-27 23:31:38 +00:00
Tony Ly
96a6d469e9 📝 Update includes in docs/en/docs/tutorial/encoder.md (#12597) 2024-10-27 23:31:16 +00:00
github-actions
dbc3008f5a 📝 Update release notes 2024-10-27 22:54:10 +00:00
Philip Okiokio
95ebac1a89 📝 Update includes in docs/en/docs/how-to/custom-docs-ui-assets.md (#12557) 2024-10-27 22:53:46 +00:00
github-actions
04194dc191 📝 Update release notes 2024-10-27 22:39:58 +00:00
Alejandra
eea2d8e67c 🎨 Adjust spacing (#12635) 2024-10-27 22:39:38 +00:00
github-actions
5db8b491db 📝 Update release notes 2024-10-27 22:12:53 +00:00
Philip Okiokio
78f295609f 📝 Update includes in docs/en/docs/how-to/custom-request-and-route.md (#12560) 2024-10-27 22:12:32 +00:00
github-actions
d92fc89eb8 📝 Update release notes 2024-10-27 22:02:27 +00:00
namjimin_43
2c27cae742 🌐 Add Korean Translation for docs/ko/docs/advanced/response-change-status-code.md (#12547) 2024-10-27 22:01:39 +00:00
Sebastián Ramírez
31887b1cc6 🔖 Release version 0.115.4 2024-10-27 21:51:55 +00:00
github-actions
b270ff1e5e 📝 Update release notes 2024-10-27 21:46:51 +00:00
Sebastián Ramírez
b31cbbf5f5 ♻️ Update logic to import and check python-multipart for compatibility with newer version (#12627) 2024-10-27 21:46:26 +00:00
github-actions
aee7674ed2 📝 Update release notes 2024-10-27 17:35:05 +00:00
Quentin Takeda
4e6b1acccd 📝 Update includes in docs/fr/docs/tutorial/body.md (#12596) 2024-10-27 17:34:41 +00:00
github-actions
9b1e5f29e6 📝 Update release notes 2024-10-27 17:31:38 +00:00
Quentin Takeda
60aba0261c 📝 Update includes in docs/fr/docs/tutorial/debugging.md (#12595) 2024-10-27 17:31:14 +00:00
github-actions
2a4cf1736d 📝 Update release notes 2024-10-27 17:16:01 +00:00
Quentin Takeda
453f559934 📝 Update includes in docs/fr/docs/tutorial/query-params-str-validations.md (#12591) 2024-10-27 17:14:38 +00:00
github-actions
af269cd131 📝 Update release notes 2024-10-27 17:09:22 +00:00
Quentin Takeda
5e8f1f96eb 📝 Update includes in docs/fr/docs/tutorial/query-params.md (#12589) 2024-10-27 17:06:01 +00:00
github-actions
9f44a5dd36 📝 Update release notes 2024-10-27 17:02:42 +00:00
github-actions
ba77d114f6 📝 Update release notes 2024-10-27 17:02:19 +00:00
github-actions
cd37dfe533 📝 Update release notes 2024-10-27 17:01:22 +00:00
Nomad Monad
47b4e1a517 📝 Update includes in docs/en/tutorial/body-fields.md (#12588) 2024-10-27 17:01:18 +00:00
Alexander Bejarano
503ece76d6 📝 Update includes in docs/de/docs/tutorial/response-status-code.md (#12585) 2024-10-27 16:59:43 +00:00
Nomad Monad
5a0e13794b 📝 Update includes in docs/en/docs/tutorial/body.md (#12586) 2024-10-27 16:58:19 +00:00
github-actions
75af54babd 📝 Update release notes 2024-10-27 16:52:29 +00:00
github-actions
083fbc8a73 📝 Update release notes 2024-10-27 16:52:28 +00:00
Sebastian Kozłowski
3783341eb8 📝 Update includes syntax for docs/pl/docs/tutorial/first-steps.md (#12584) 2024-10-27 16:51:30 +00:00
Julio Anthony Leonard
f0ad433e01 📝 Update includes in docs/en/docs/advanced/behind-a-proxy.md (#12583) 2024-10-27 16:49:49 +00:00
github-actions
5b1963db49 📝 Update release notes 2024-10-27 16:46:14 +00:00
Graziano Montanaro
5d99a42688 📝 Update includes in docs/en/docs/advanced/middleware.md (#12582) 2024-10-27 16:45:50 +00:00
github-actions
f5a10c1c7d 📝 Update release notes 2024-10-27 16:17:51 +00:00
github-actions
fe60afff0e 📝 Update release notes 2024-10-27 16:13:50 +00:00
Krishna Madhavan
dc7cf0f14f 📝 Update includes in docs/en/docs/advanced/additional-status-codes.md (#12577) 2024-10-27 16:12:23 +00:00
Krishna Madhavan
9106cae8a8 📝 Update includes in docs/en/docs/advanced/advanced-dependencies.md (#12578) 2024-10-27 16:10:15 +00:00
github-actions
dc22bdf5a4 📝 Update release notes 2024-10-27 16:08:49 +00:00
Krishna Madhavan
0f8d03ef85 📝 Update includes in docs/en/docs/advanced/additional-responses.md (#12576) 2024-10-27 16:07:07 +00:00
github-actions
55aa76faad 📝 Update release notes 2024-10-27 15:51:51 +00:00
github-actions
ed45eca1a8 📝 Update release notes 2024-10-27 15:50:02 +00:00
Nomad Monad
b24b4fd6a8 📝 Update includes in docs/en/docs/tutorial/static-files.md (#12575) 2024-10-27 15:45:40 +00:00
Krishna Madhavan
dfdecfd9c9 📝 Update includes in docs/en/docs/advanced/async-tests.md (#12568) 2024-10-27 15:43:29 +00:00
github-actions
4b9e76bde2 📝 Update release notes 2024-10-27 15:39:25 +00:00
Julio Anthony Leonard
27e7fcefe8 📝 Update includes in docs/de/docs/advanced/async-tests.md (#12567) 2024-10-27 15:34:47 +00:00
github-actions
48f88edf0d 📝 Update release notes 2024-10-27 15:33:12 +00:00
github-actions
91eb00854b 📝 Update release notes 2024-10-27 15:30:02 +00:00
github-actions
e00efb5569 📝 Update release notes 2024-10-27 15:29:12 +00:00
Alexandros Mioglou
909204ec54 📝 Update includes in docs/pt/docs/advanced/behind-a-proxy.md (#12563) 2024-10-27 15:28:18 +00:00
Nimitha J
b87eb8a0e1 📝 Update includes in docs/de/docs/advanced/security/http-basic-auth.md (#12561) 2024-10-27 15:25:54 +00:00
ilacftemp
92bc3d7e0c 🌐 Add Portuguese translation for docs/pt/docs/tutorial/sql-databases.md (#12530) 2024-10-27 15:25:29 +00:00
github-actions
13f3dd2111 📝 Update release notes 2024-10-27 15:24:07 +00:00
github-actions
4f5349445d 📝 Update release notes 2024-10-27 15:24:00 +00:00
Farhan Ali Raza
4ae5fab050 📝 Update includes in docs/en/docs/tutorial/background-tasks.md (#12559) 2024-10-27 15:22:48 +00:00
Ismail Tlemcani
1fbbf9ca6c 📝 Update includes in docs/fr/docs/python-types.md (#12558) 2024-10-27 15:21:34 +00:00
github-actions
a1572b52de 📝 Update release notes 2024-10-27 15:19:49 +00:00
Philip Okiokio
50c6f80117 📝 Update includes in docs/en/docs/how-to/graphql.md (#12564) 2024-10-27 15:18:53 +00:00
github-actions
aec5219fe0 📝 Update release notes 2024-10-27 15:15:30 +00:00
Philip Okiokio
092da9a8a3 📝 Update includes in docs/en/docs/how-to/extending-openapi.md (#12562) 2024-10-27 15:15:05 +00:00
github-actions
128c96dc9a 📝 Update release notes 2024-10-27 15:02:00 +00:00
임선오
8d928def2e 🌐 Add Korean translation for docs/ko/docs/benchmarks.md (#12540) 2024-10-27 15:01:38 +00:00
github-actions
44cfb2f4f5 📝 Update release notes 2024-10-26 16:51:17 +00:00
Sebastián Ramírez
162a32cc2f 📝 Update includes for docs/en/docs/how-to/configure-swagger-ui.md (#12556) 2024-10-26 16:50:52 +00:00
github-actions
d93e431505 📝 Update release notes 2024-10-26 16:44:15 +00:00
Sebastián Ramírez
28e97b2651 📝 Update includes for docs/en/docs/how-to/separate-openapi-schemas.md (#12555) 2024-10-26 17:43:54 +01:00
github-actions
6e85909311 📝 Update release notes 2024-10-26 16:01:48 +00:00
Sebastián Ramírez
68d0a0412e 📝 Update includes for docs/en/docs/advanced/security/http-basic-auth.md (#12553) 2024-10-26 17:01:27 +01:00
github-actions
63c3eacf43 📝 Update release notes 2024-10-26 11:51:54 +00:00
github-actions
442692fef4 📝 Update release notes 2024-10-26 11:49:36 +00:00
Sebastián Ramírez
56bc9a5eb4 📝 Update includes in docs/en/docs/tutorial/first-steps.md (#12552) 2024-10-26 11:48:16 +00:00
Sebastián Ramírez
71fcafd13c 📝 Update includes in docs/en/docs/python-types.md (#12551) 2024-10-26 11:47:53 +00:00
github-actions
ea88ab6cf1 📝 Update release notes 2024-10-26 11:46:28 +00:00
Sebastián Ramírez
89f06da526 📝 Fix link in OAuth2 docs (#12550) 2024-10-26 11:45:10 +00:00
github-actions
d60c52bc32 📝 Update release notes 2024-10-26 09:38:20 +00:00
dependabot[bot]
fd95b4ae65 ⬆ Bump cloudflare/wrangler-action from 3.9 to 3.11 (#12544)
Bumps [cloudflare/wrangler-action](https://github.com/cloudflare/wrangler-action) from 3.9 to 3.11.
- [Release notes](https://github.com/cloudflare/wrangler-action/releases)
- [Changelog](https://github.com/cloudflare/wrangler-action/blob/main/CHANGELOG.md)
- [Commits](https://github.com/cloudflare/wrangler-action/compare/v3.9...v3.11)

---
updated-dependencies:
- dependency-name: cloudflare/wrangler-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-10-26 10:37:59 +01:00
github-actions
a498582bb4 📝 Update release notes 2024-10-24 18:54:28 +00:00
ilacftemp
55bcab6d75 🌐 Add Portuguese translation for docs/pt/docs/how-to/separate-openapi-schemas.md (#12518) 2024-10-24 18:52:36 +00:00
github-actions
548f938280 📝 Update release notes 2024-10-24 18:43:50 +00:00
Renne Rocha
ec9b066e0b 📝 Add External Link: FastAPI do Zero (#12533) 2024-10-24 18:39:34 +00:00
github-actions
cf65c423d1 📝 Update release notes 2024-10-24 18:35:26 +00:00
github-actions
e2d77a9e42 📝 Update release notes 2024-10-24 18:32:39 +00:00
YungYueh ChanLee
86fe251507 🌐 Update Traditional Chinese translation for docs/zh-hant/docs/deployment/index.md (#12521) 2024-10-24 19:30:54 +01:00
github-actions
b5021a4c84 📝 Update release notes 2024-10-24 18:29:27 +00:00
YungYueh ChanLee
ff5f076011 🌐 Update Traditional Chinese translation for docs/zh-hant/docs/deployment/cloud.md (#12522) 2024-10-24 19:28:55 +01:00
github-actions
b144221ad5 📝 Update release notes 2024-10-24 18:28:22 +00:00
YungYueh ChanLee
7b03fa7e0c 🌐 Update Traditional Chinese translation for docs/zh-hant/docs/how-to/index.md (#12523) 2024-10-24 19:28:16 +01:00
YungYueh ChanLee
2f2c877d51 🌐 Update Traditional Chinese translation for docs/zh-hant/docs/tutorial/index.md (#12524) 2024-10-24 19:28:00 +01:00
github-actions
6ede04f876 📝 Update release notes 2024-10-24 12:39:00 +00:00
Sebastián Ramírez
e7533b92b3 👷 Update GitHub Action to deploy docs previews to handle missing deploy comments (#12527) 2024-10-24 12:38:34 +00:00
github-actions
593385d1c3 📝 Update release notes 2024-10-23 18:30:47 +00:00
Kevin Kirsche
8081d2302e 📝 Fix minor typos (#12516) 2024-10-23 19:30:18 +01:00
github-actions
2d43a8a2a3 📝 Update release notes 2024-10-22 20:48:21 +00:00
github-actions
21fc89976d 📝 Update release notes 2024-10-22 20:47:24 +00:00
YungYueh ChanLee
59efc69bec 🌐 Add Traditional Chinese translation for docs/zh-hant/docs/how-to/index.md (#12468) 2024-10-22 21:45:13 +01:00
YungYueh ChanLee
136c48bda6 🌐 Add Traditional Chinese translation for docs/zh-hant/docs/tutorial/index.md (#12466) 2024-10-22 21:44:51 +01:00
github-actions
fb4b6b7cbe 📝 Update release notes 2024-10-22 20:42:37 +00:00
João Pedro Pereira Holanda
c9337b54f0 🌐 Add Portuguese translation for docs/pt/docs/tutorial/header-param-models.md (#12437) 2024-10-22 21:41:28 +01:00
github-actions
69cc3161fc 📝 Update release notes 2024-10-22 20:41:15 +00:00
pre-commit-ci[bot]
13c57834a5 ⬆ [pre-commit.ci] pre-commit autoupdate (#12505)
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.6.9 → v0.7.0](https://github.com/astral-sh/ruff-pre-commit/compare/v0.6.9...v0.7.0)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2024-10-22 21:40:52 +01:00
github-actions
92df4e7903 📝 Update release notes 2024-10-22 20:28:24 +00:00
Alejandra
c1f91a0403 🌐 Fix rendering issue in translations (#12509) 2024-10-22 21:28:02 +01:00
github-actions
180e72b193 📝 Update release notes 2024-10-22 17:41:57 +00:00
ilacftemp
d5a0456084 🌐 Add Portuguese translation for docs/pt/docs/how-to/extending-openapi.md (#12470) 2024-10-22 17:40:08 +00:00
github-actions
396c0f6aab 📝 Update release notes 2024-10-22 17:36:16 +00:00
Leonardo Scarlato
bbcee4db19 🌐 Add Portuguese translation for docs/pt/docs/advanced/dataclasses.md (#12475) 2024-10-22 18:33:53 +01:00
github-actions
cb74448bd9 📝 Update release notes 2024-10-22 17:33:23 +00:00
Fernando Alzueta
94fafa5030 🌐 Add Portuguese translation for docs/pt/docs/how-to/custom-request-and-route.md (#12483) 2024-10-22 18:33:00 +01:00
555 changed files with 8454 additions and 12762 deletions

View File

@@ -62,7 +62,10 @@ jobs:
env:
PROJECT_NAME: fastapitiangolo
BRANCH: ${{ ( github.event.workflow_run.head_repository.full_name == github.repository && github.event.workflow_run.head_branch == 'master' && 'main' ) || ( github.event.workflow_run.head_sha ) }}
uses: cloudflare/wrangler-action@v3
# TODO: Use v3 when it's fixed, probably in v3.11
# https://github.com/cloudflare/wrangler-action/issues/307
uses: cloudflare/wrangler-action@v3.12
# uses: cloudflare/wrangler-action@v3
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}

View File

@@ -34,7 +34,7 @@ jobs:
if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
with:
limit-access-to-actor: true
- uses: tiangolo/latest-changes@0.3.1
- uses: tiangolo/latest-changes@0.3.2
with:
token: ${{ secrets.GITHUB_TOKEN }}
latest_changes_file: docs/en/docs/release-notes.md

View File

@@ -35,7 +35,7 @@ jobs:
TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }}
run: python -m build
- name: Publish
uses: pypa/gh-action-pypi-publish@v1.10.3
uses: pypa/gh-action-pypi-publish@v1.12.2
- name: Dump GitHub context
env:
GITHUB_CONTEXT: ${{ toJson(github) }}

View File

@@ -14,7 +14,7 @@ repos:
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.6.9
rev: v0.7.3
hooks:
- id: ruff
args:

View File

@@ -56,6 +56,7 @@ The key features are:
<a href="https://www.mongodb.com/developer/languages/python/python-quickstart-fastapi/?utm_campaign=fastapi_framework&utm_source=fastapi_sponsorship&utm_medium=web_referral" target="_blank" title="Simplify Full Stack Development with FastAPI & MongoDB"><img src="https://fastapi.tiangolo.com/img/sponsors/mongodb.png"></a>
<a href="https://zuplo.link/fastapi-gh" target="_blank" title="Zuplo: Scale, Protect, Document, and Monetize your FastAPI"><img src="https://fastapi.tiangolo.com/img/sponsors/zuplo.png"></a>
<a href="https://liblab.com?utm_source=fastapi" target="_blank" title="liblab - Generate SDKs from FastAPI"><img src="https://fastapi.tiangolo.com/img/sponsors/liblab.png"></a>
<a href="https://docs.render.com/deploy-fastapi?utm_source=deploydoc&utm_medium=referral&utm_campaign=fastapi" target="_blank" title="Deploy & scale any full-stack web app on Render. Focus on building apps, not infra."><img src="https://fastapi.tiangolo.com/img/sponsors/render.svg"></a>
<a href="https://github.com/deepset-ai/haystack/" target="_blank" title="Build powerful search from composable, open source building blocks"><img src="https://fastapi.tiangolo.com/img/sponsors/haystack-fastapi.svg"></a>
<a href="https://databento.com/" target="_blank" title="Pay as you go for market data"><img src="https://fastapi.tiangolo.com/img/sponsors/databento.svg"></a>
<a href="https://speakeasy.com?utm_source=fastapi+repo&utm_medium=github+sponsorship" target="_blank" title="SDKs for your API | Speakeasy"><img src="https://fastapi.tiangolo.com/img/sponsors/speakeasy.png"></a>

View File

@@ -1,6 +1,6 @@
# Zusätzliche Responses in OpenAPI
/// warning | "Achtung"
/// warning | Achtung
Dies ist ein eher fortgeschrittenes Thema.
@@ -26,11 +26,9 @@ Jedes dieser Response-`dict`s kann einen Schlüssel `model` haben, welcher ein P
Um beispielsweise eine weitere Response mit dem Statuscode `404` und einem Pydantic-Modell `Message` zu deklarieren, können Sie schreiben:
```Python hl_lines="18 22"
{!../../docs_src/additional_responses/tutorial001.py!}
```
{* ../../docs_src/additional_responses/tutorial001.py hl[18,22] *}
/// note | "Hinweis"
/// note | Hinweis
Beachten Sie, dass Sie die `JSONResponse` direkt zurückgeben müssen.
@@ -177,11 +175,9 @@ Sie können denselben `responses`-Parameter verwenden, um verschiedene Medientyp
Sie können beispielsweise einen zusätzlichen Medientyp `image/png` hinzufügen und damit deklarieren, dass Ihre *Pfadoperation* ein JSON-Objekt (mit dem Medientyp `application/json`) oder ein PNG-Bild zurückgeben kann:
```Python hl_lines="19-24 28"
{!../../docs_src/additional_responses/tutorial002.py!}
```
{* ../../docs_src/additional_responses/tutorial002.py hl[19:24,28] *}
/// note | "Hinweis"
/// note | Hinweis
Beachten Sie, dass Sie das Bild direkt mit einer `FileResponse` zurückgeben müssen.
@@ -207,9 +203,7 @@ Sie können beispielsweise eine Response mit dem Statuscode `404` deklarieren, d
Und eine Response mit dem Statuscode `200`, die Ihr `response_model` verwendet, aber ein benutzerdefiniertes Beispiel (`example`) enthält:
```Python hl_lines="20-31"
{!../../docs_src/additional_responses/tutorial003.py!}
```
{* ../../docs_src/additional_responses/tutorial003.py hl[20:31] *}
Es wird alles kombiniert und in Ihre OpenAPI eingebunden und in der API-Dokumentation angezeigt:
@@ -243,9 +237,7 @@ Mit dieser Technik können Sie einige vordefinierte Responses in Ihren *Pfadoper
Zum Beispiel:
```Python hl_lines="13-17 26"
{!../../docs_src/additional_responses/tutorial004.py!}
```
{* ../../docs_src/additional_responses/tutorial004.py hl[13:17,26] *}
## Weitere Informationen zu OpenAPI-Responses

View File

@@ -40,7 +40,7 @@ Um dies zu erreichen, importieren Sie `JSONResponse`, und geben Sie Ihren Inhalt
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -54,7 +54,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -66,7 +66,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// warning | "Achtung"
/// warning | Achtung
Wenn Sie eine `Response` direkt zurückgeben, wie im obigen Beispiel, wird sie direkt zurückgegeben.
@@ -76,7 +76,7 @@ Stellen Sie sicher, dass sie die gewünschten Daten enthält und dass die Werte
///
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette.responses import JSONResponse` verwenden.

View File

@@ -36,7 +36,7 @@ Dazu deklarieren wir eine Methode `__call__`:
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -72,7 +72,7 @@ Und jetzt können wir `__init__` verwenden, um die Parameter der Instanz zu dekl
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -108,7 +108,7 @@ Wir könnten eine Instanz dieser Klasse erstellen mit:
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -152,7 +152,7 @@ checker(q="somequery")
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -164,7 +164,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// tip | "Tipp"
/// tip | Tipp
Das alles mag gekünstelt wirken. Und es ist möglicherweise noch nicht ganz klar, welchen Nutzen das hat.

View File

@@ -60,11 +60,9 @@ $ pytest
Der Marker `@pytest.mark.anyio` teilt pytest mit, dass diese Testfunktion asynchron aufgerufen werden soll:
```Python hl_lines="7"
{!../../docs_src/async_tests/test_main.py!}
```
{* ../../docs_src/async_tests/test_main.py hl[7] *}
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass die Testfunktion jetzt `async def` ist und nicht nur `def` wie zuvor, wenn Sie den `TestClient` verwenden.
@@ -72,9 +70,7 @@ Beachten Sie, dass die Testfunktion jetzt `async def` ist und nicht nur `def` wi
Dann können wir einen `AsyncClient` mit der App erstellen und mit `await` asynchrone Requests an ihn senden.
```Python hl_lines="9-12"
{!../../docs_src/async_tests/test_main.py!}
```
{* ../../docs_src/async_tests/test_main.py hl[9:12] *}
Das ist das Äquivalent zu:
@@ -84,13 +80,13 @@ response = client.get('/')
... welches wir verwendet haben, um unsere Requests mit dem `TestClient` zu machen.
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass wir async/await mit dem neuen `AsyncClient` verwenden der Request ist asynchron.
///
/// warning | "Achtung"
/// warning | Achtung
Falls Ihre Anwendung auf Lifespan-Events angewiesen ist, der `AsyncClient` löst diese Events nicht aus. Um sicherzustellen, dass sie ausgelöst werden, verwenden Sie `LifespanManager` von <a href="https://github.com/florimondmanca/asgi-lifespan#usage" class="external-link" target="_blank">florimondmanca/asgi-lifespan</a>.
@@ -100,7 +96,7 @@ Falls Ihre Anwendung auf Lifespan-Events angewiesen ist, der `AsyncClient` löst
Da die Testfunktion jetzt asynchron ist, können Sie in Ihren Tests neben dem Senden von Requests an Ihre FastAPI-Anwendung jetzt auch andere `async`hrone Funktionen aufrufen (und `await`en), genau so, wie Sie diese an anderer Stelle in Ihrem Code aufrufen würden.
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie einen `RuntimeError: Task attached to a different loop` erhalten, wenn Sie asynchrone Funktionsaufrufe in Ihre Tests integrieren (z. B. bei Verwendung von <a href="https://stackoverflow.com/questions/41584243/runtimeerror-task-attached-to-a-different-loop" class="external-link" target="_blank">MongoDBs MotorClient</a>), dann denken Sie daran, Objekte zu instanziieren, die einen Event Loop nur innerhalb asynchroner Funktionen benötigen, z. B. einen `@app.on_event("startup")`-Callback.

View File

@@ -43,7 +43,7 @@ browser --> proxy
proxy --> server
```
/// tip | "Tipp"
/// tip | Tipp
Die IP `0.0.0.0` wird üblicherweise verwendet, um anzudeuten, dass das Programm alle auf diesem Computer/Server verfügbaren IPs abhört.
@@ -84,7 +84,7 @@ $ uvicorn main:app --root-path /api/v1
Falls Sie Hypercorn verwenden, das hat auch die Option `--root-path`.
/// note | "Technische Details"
/// note | Technische Details
Die ASGI-Spezifikation definiert einen `root_path` für diesen Anwendungsfall.
@@ -178,7 +178,7 @@ Dann erstellen Sie eine Datei `traefik.toml` mit:
Dadurch wird Traefik angewiesen, Port 9999 abzuhören und eine andere Datei `routes.toml` zu verwenden.
/// tip | "Tipp"
/// tip | Tipp
Wir verwenden Port 9999 anstelle des Standard-HTTP-Ports 80, damit Sie ihn nicht mit Administratorrechten (`sudo`) ausführen müssen.
@@ -248,7 +248,7 @@ Wenn Sie nun zur URL mit dem Port für Uvicorn gehen: <a href="http://127.0.0.1:
}
```
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass, obwohl Sie unter `http://127.0.0.1:8000/app` darauf zugreifen, als `root_path` angezeigt wird `/api/v1`, welches aus der Option `--root-path` stammt.
@@ -295,7 +295,7 @@ Dies liegt daran, dass FastAPI diesen `root_path` verwendet, um den Default-`ser
## Zusätzliche Server
/// warning | "Achtung"
/// warning | Achtung
Dies ist ein fortgeschrittener Anwendungsfall. Überspringen Sie das gerne.
@@ -338,7 +338,7 @@ Erzeugt ein OpenAPI-Schema, wie:
}
```
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie den automatisch generierten Server mit dem `URL`-Wert `/api/v1`, welcher vom `root_path` stammt.
@@ -348,7 +348,7 @@ In der Dokumentationsoberfläche unter <a href="http://127.0.0.1:9999/api/v1/doc
<img src="/img/tutorial/behind-a-proxy/image03.png">
/// tip | "Tipp"
/// tip | Tipp
Die Dokumentationsoberfläche interagiert mit dem von Ihnen ausgewählten Server.

View File

@@ -12,7 +12,7 @@ Der Inhalt, den Sie von Ihrer *Pfadoperation-Funktion* zurückgeben, wird in die
Und wenn diese `Response` einen JSON-Medientyp (`application/json`) hat, wie es bei `JSONResponse` und `UJSONResponse` der Fall ist, werden die von Ihnen zurückgegebenen Daten automatisch mit jedem Pydantic `response_model` konvertiert (und gefiltert), das Sie im *Pfadoperation-Dekorator* deklariert haben.
/// note | "Hinweis"
/// note | Hinweis
Wenn Sie eine Response-Klasse ohne Medientyp verwenden, erwartet FastAPI, dass Ihre Response keinen Inhalt hat, und dokumentiert daher das Format der Response nicht in deren generierter OpenAPI-Dokumentation.
@@ -44,7 +44,7 @@ Und er wird als solcher in OpenAPI dokumentiert.
///
/// tip | "Tipp"
/// tip | Tipp
Die `ORJSONResponse` ist derzeit nur in FastAPI verfügbar, nicht in Starlette.
@@ -81,7 +81,7 @@ Das gleiche Beispiel von oben, das eine `HTMLResponse` zurückgibt, könnte so a
{!../../docs_src/custom_response/tutorial003.py!}
```
/// warning | "Achtung"
/// warning | Achtung
Eine `Response`, die direkt von Ihrer *Pfadoperation-Funktion* zurückgegeben wird, wird in OpenAPI nicht dokumentiert (zum Beispiel wird der `Content-Type` nicht dokumentiert) und ist in der automatischen interaktiven Dokumentation nicht sichtbar.
@@ -121,7 +121,7 @@ Hier sind einige der verfügbaren Responses.
Bedenken Sie, dass Sie `Response` verwenden können, um alles andere zurückzugeben, oder sogar eine benutzerdefinierte Unterklasse zu erstellen.
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette.responses import HTMLResponse` verwenden.
@@ -174,7 +174,7 @@ Eine schnelle alternative JSON-Response mit <a href="https://github.com/ijl/orjs
Eine alternative JSON-Response mit <a href="https://github.com/ultrajson/ultrajson" class="external-link" target="_blank">`ujson`</a>.
/// warning | "Achtung"
/// warning | Achtung
`ujson` ist bei der Behandlung einiger Sonderfälle weniger sorgfältig als Pythons eingebaute Implementierung.
@@ -184,7 +184,7 @@ Eine alternative JSON-Response mit <a href="https://github.com/ultrajson/ultrajs
{!../../docs_src/custom_response/tutorial001.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Möglicherweise ist `ORJSONResponse` eine schnellere Alternative.
@@ -249,7 +249,7 @@ Das umfasst viele Bibliotheken zur Interaktion mit Cloud-Speicher, Videoverarbei
Auf diese Weise können wir das Ganze in einen `with`-Block einfügen und so sicherstellen, dass das dateiartige Objekt nach Abschluss geschlossen wird.
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass wir, da wir Standard-`open()` verwenden, welches `async` und `await` nicht unterstützt, hier die Pfadoperation mit normalen `def` deklarieren.
@@ -322,7 +322,7 @@ Im folgenden Beispiel verwendet **FastAPI** standardmäßig `ORJSONResponse` in
{!../../docs_src/custom_response/tutorial010.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Sie können dennoch weiterhin `response_class` in *Pfadoperationen* überschreiben, wie bisher.

View File

@@ -4,9 +4,7 @@ FastAPI basiert auf **Pydantic** und ich habe Ihnen gezeigt, wie Sie Pydantic-Mo
Aber FastAPI unterstützt auf die gleiche Weise auch die Verwendung von <a href="https://docs.python.org/3/library/dataclasses.html" class="external-link" target="_blank">`dataclasses`</a>:
```Python hl_lines="1 7-12 19-20"
{!../../docs_src/dataclasses/tutorial001.py!}
```
{* ../../docs_src/dataclasses/tutorial001.py hl[1,7:12,19:20] *}
Das ist dank **Pydantic** ebenfalls möglich, da es <a href="https://pydantic-docs.helpmanual.io/usage/dataclasses/#use-of-stdlib-dataclasses-with-basemodel" class="external-link" target="_blank">`dataclasses` intern unterstützt</a>.
@@ -34,9 +32,7 @@ Wenn Sie jedoch eine Menge Datenklassen herumliegen haben, ist dies ein guter Tr
Sie können `dataclasses` auch im Parameter `response_model` verwenden:
```Python hl_lines="1 7-13 19"
{!../../docs_src/dataclasses/tutorial002.py!}
```
{* ../../docs_src/dataclasses/tutorial002.py hl[1,7:13,19] *}
Die Datenklasse wird automatisch in eine Pydantic-Datenklasse konvertiert.
@@ -52,9 +48,7 @@ In einigen Fällen müssen Sie möglicherweise immer noch Pydantics Version von
In diesem Fall können Sie einfach die Standard-`dataclasses` durch `pydantic.dataclasses` ersetzen, was einen direkten Ersatz darstellt:
```{ .python .annotate hl_lines="1 5 8-11 14-17 23-25 28" }
{!../../docs_src/dataclasses/tutorial003.py!}
```
{* ../../docs_src/dataclasses/tutorial003.py hl[1,5,8:11,14:17,23:25,28] *}
1. Wir importieren `field` weiterhin von Standard-`dataclasses`.

View File

@@ -38,7 +38,7 @@ Hier simulieren wir das langsame *Hochfahren*, das Laden des Modells, indem wir
Und dann, direkt nach dem `yield`, entladen wir das Modell. Dieser Code wird unmittelbar vor dem *Herunterfahren* ausgeführt, **nachdem** die Anwendung **die Bearbeitung von Requests abgeschlossen hat**. Dadurch könnten beispielsweise Ressourcen wie Arbeitsspeicher oder eine GPU freigegeben werden.
/// tip | "Tipp"
/// tip | Tipp
Das *Herunterfahren* würde erfolgen, wenn Sie die Anwendung **stoppen**.
@@ -94,7 +94,7 @@ Der Parameter `lifespan` der `FastAPI`-App benötigt einen **asynchronen Kontext
## Alternative Events (deprecated)
/// warning | "Achtung"
/// warning | Achtung
Der empfohlene Weg, das *Hochfahren* und *Herunterfahren* zu handhaben, ist die Verwendung des `lifespan`-Parameters der `FastAPI`-App, wie oben beschrieben. Wenn Sie einen `lifespan`-Parameter übergeben, werden die `startup`- und `shutdown`-Eventhandler nicht mehr aufgerufen. Es ist entweder alles `lifespan` oder alles Events, nicht beides.
@@ -138,7 +138,7 @@ In der Funktion `open()` bedeutet `mode="a"` „append“ („anhängen“), sod
///
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass wir in diesem Fall eine Standard-Python-Funktion `open()` verwenden, die mit einer Datei interagiert.

View File

@@ -127,7 +127,7 @@ Sie erhalten außerdem automatische Vervollständigung für die zu sendende Payl
<img src="/img/tutorial/generate-clients/image03.png">
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie die automatische Vervollständigung für `name` und `price`, welche in der FastAPI-Anwendung im `Item`-Modell definiert wurden.

View File

@@ -6,7 +6,7 @@ Das Haupt-[Tutorial Benutzerhandbuch](../tutorial/index.md){.internal-link t
In den nächsten Abschnitten sehen Sie weitere Optionen, Konfigurationen und zusätzliche Funktionen.
/// tip | "Tipp"
/// tip | Tipp
Die nächsten Abschnitte sind **nicht unbedingt „fortgeschritten“**.

View File

@@ -43,7 +43,7 @@ app.add_middleware(UnicornMiddleware, some_config="rainbow")
**FastAPI** enthält mehrere Middlewares für gängige Anwendungsfälle. Wir werden als Nächstes sehen, wie man sie verwendet.
/// note | "Technische Details"
/// note | Technische Details
Für die nächsten Beispiele könnten Sie auch `from starlette.middleware.something import SomethingMiddleware` verwenden.

View File

@@ -35,7 +35,7 @@ Dieser Teil ist ziemlich normal, der größte Teil des Codes ist Ihnen wahrschei
{!../../docs_src/openapi_callbacks/tutorial001.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Der Query-Parameter `callback_url` verwendet einen Pydantic-<a href="https://docs.pydantic.dev/latest/api/networks/" class="external-link" target="_blank">Url</a>-Typ.
@@ -64,7 +64,7 @@ Diese Dokumentation wird in der Swagger-Oberfläche unter `/docs` in Ihrer API a
In diesem Beispiel wird nicht der Callback selbst implementiert (das könnte nur eine Codezeile sein), sondern nur der Dokumentationsteil.
/// tip | "Tipp"
/// tip | Tipp
Der eigentliche Callback ist nur ein HTTP-Request.
@@ -80,7 +80,7 @@ Sie wissen jedoch bereits, wie Sie mit **FastAPI** ganz einfach eine automatisch
Daher werden wir dasselbe Wissen nutzen, um zu dokumentieren, wie die *externe API* aussehen sollte ... indem wir die *Pfadoperation(en)* erstellen, welche die externe API implementieren soll (die, welche Ihre API aufruft).
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie den Code zum Dokumentieren eines Callbacks schreiben, kann es hilfreich sein, sich vorzustellen, dass Sie dieser *externe Entwickler* sind. Und dass Sie derzeit die *externe API* implementieren, nicht *Ihre API*.
@@ -163,7 +163,7 @@ und sie würde eine Response von dieser *externen API* mit einem JSON-Body wie d
}
```
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass die verwendete Callback-URL die URL enthält, die als Query-Parameter in `callback_url` (`https://www.external.org/events`) empfangen wurde, und auch die Rechnungs-`id` aus dem JSON-Body (`2expen51ve`).
@@ -179,7 +179,7 @@ Verwenden Sie nun den Parameter `callbacks` im *Pfadoperation-Dekorator Ihrer AP
{!../../docs_src/openapi_callbacks/tutorial001.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass Sie nicht den Router selbst (`invoices_callback_router`) an `callback=` übergeben, sondern das Attribut `.routes`, wie in `invoices_callback_router.routes`.

View File

@@ -2,7 +2,7 @@
## OpenAPI operationId
/// warning | "Achtung"
/// warning | Achtung
Wenn Sie kein „Experte“ für OpenAPI sind, brauchen Sie dies wahrscheinlich nicht.
@@ -26,13 +26,13 @@ Sie sollten dies tun, nachdem Sie alle Ihre *Pfadoperationen* hinzugefügt haben
{!../../docs_src/path_operation_advanced_configuration/tutorial002.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie `app.openapi()` manuell aufrufen, sollten Sie vorher die `operationId`s aktualisiert haben.
///
/// warning | "Achtung"
/// warning | Achtung
Wenn Sie dies tun, müssen Sie sicherstellen, dass jede Ihrer *Pfadoperation-Funktionen* einen eindeutigen Namen hat.
@@ -74,7 +74,7 @@ Es gibt hier in der Dokumentation ein ganzes Kapitel darüber, Sie können es un
Wenn Sie in Ihrer Anwendung eine *Pfadoperation* deklarieren, generiert **FastAPI** automatisch die relevanten Metadaten dieser *Pfadoperation*, die in das OpenAPI-Schema aufgenommen werden sollen.
/// note | "Technische Details"
/// note | Technische Details
In der OpenAPI-Spezifikation wird das <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object" class="external-link" target="_blank">Operationsobjekt</a> genannt.
@@ -86,7 +86,7 @@ Es enthält `tags`, `parameters`, `requestBody`, `responses`, usw.
Dieses *Pfadoperation*-spezifische OpenAPI-Schema wird normalerweise automatisch von **FastAPI** generiert, Sie können es aber auch erweitern.
/// tip | "Tipp"
/// tip | Tipp
Dies ist ein Low-Level Erweiterungspunkt.
@@ -215,7 +215,7 @@ In Pydantic Version 1 war die Methode zum Parsen und Validieren eines Objekts `I
///
/// tip | "Tipp"
/// tip | Tipp
Hier verwenden wir dasselbe Pydantic-Modell wieder.

View File

@@ -30,7 +30,7 @@ Setzen Sie dann Cookies darin und geben Sie sie dann zurück:
{!../../docs_src/response_cookies/tutorial001.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass, wenn Sie eine Response direkt zurückgeben, anstatt den `Response`-Parameter zu verwenden, FastAPI diese direkt zurückgibt.
@@ -42,7 +42,7 @@ Und auch, dass Sie keine Daten senden, die durch ein `response_model` hätten ge
### Mehr Informationen
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette.responses import Response` oder `from starlette.responses import JSONResponse` verwenden.

View File

@@ -14,7 +14,7 @@ Das kann beispielsweise nützlich sein, um benutzerdefinierte Header oder Cookie
Tatsächlich können Sie jede `Response` oder jede Unterklasse davon zurückgeben.
/// tip | "Tipp"
/// tip | Tipp
`JSONResponse` selbst ist eine Unterklasse von `Response`.
@@ -38,7 +38,7 @@ In diesen Fällen können Sie den `jsonable_encoder` verwenden, um Ihre Daten zu
{!../../docs_src/response_directly/tutorial001.py!}
```
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette.responses import JSONResponse` verwenden.

View File

@@ -28,7 +28,7 @@ Erstellen Sie eine Response wie in [Eine Response direkt zurückgeben](response-
{!../../docs_src/response_headers/tutorial001.py!}
```
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette.responses import Response` oder `from starlette.responses import JSONResponse` verwenden.

View File

@@ -20,36 +20,7 @@ Wenn Sie dann den Benutzernamen und das Passwort eingeben, sendet der Browser di
* Diese gibt ein Objekt vom Typ `HTTPBasicCredentials` zurück:
* Es enthält den gesendeten `username` und das gesendete `password`.
//// tab | Python 3.9+
```Python hl_lines="4 8 12"
{!> ../../docs_src/security/tutorial006_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="2 7 11"
{!> ../../docs_src/security/tutorial006_an.py!}
```
////
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="2 6 10"
{!> ../../docs_src/security/tutorial006.py!}
```
////
{* ../../docs_src/security/tutorial006_an_py39.py hl[4,8,12] *}
Wenn Sie versuchen, die URL zum ersten Mal zu öffnen (oder in der Dokumentation auf den Button „Execute“ zu klicken), wird der Browser Sie nach Ihrem Benutzernamen und Passwort fragen:
<img src="/img/tutorial/security/image12.png">
@@ -68,35 +39,7 @@ Um dies zu lösen, konvertieren wir zunächst den `username` und das `password`
Dann können wir `secrets.compare_digest()` verwenden, um sicherzustellen, dass `credentials.username` `"stanleyjobson"` und `credentials.password` `"swordfish"` ist.
//// tab | Python 3.9+
```Python hl_lines="1 12-24"
{!> ../../docs_src/security/tutorial007_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="1 12-24"
{!> ../../docs_src/security/tutorial007_an.py!}
```
////
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="1 11-21"
{!> ../../docs_src/security/tutorial007.py!}
```
////
{* ../../docs_src/security/tutorial007_an_py39.py hl[1,12:24] *}
Dies wäre das gleiche wie:
@@ -160,32 +103,4 @@ So ist Ihr Anwendungscode, dank der Verwendung von `secrets.compare_digest()`, v
Nachdem Sie festgestellt haben, dass die Anmeldeinformationen falsch sind, geben Sie eine `HTTPException` mit dem Statuscode 401 zurück (derselbe, der auch zurückgegeben wird, wenn keine Anmeldeinformationen angegeben werden) und fügen den Header `WWW-Authenticate` hinzu, damit der Browser die Anmeldeaufforderung erneut anzeigt:
//// tab | Python 3.9+
```Python hl_lines="26-30"
{!> ../../docs_src/security/tutorial007_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="26-30"
{!> ../../docs_src/security/tutorial007_an.py!}
```
////
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="23-27"
{!> ../../docs_src/security/tutorial007.py!}
```
////
{* ../../docs_src/security/tutorial007_an_py39.py hl[26:30] *}

View File

@@ -4,7 +4,7 @@
Neben den in [Tutorial Benutzerhandbuch: Sicherheit](../../tutorial/security/index.md){.internal-link target=_blank} behandelten Funktionen gibt es noch einige zusätzliche Funktionen zur Handhabung der Sicherheit.
/// tip | "Tipp"
/// tip | Tipp
Die nächsten Abschnitte sind **nicht unbedingt „fortgeschritten“**.

View File

@@ -10,7 +10,7 @@ Jedes Mal, wenn Sie sich mit Facebook, Google, GitHub, Microsoft oder Twitter an
In diesem Abschnitt erfahren Sie, wie Sie Authentifizierung und Autorisierung mit demselben OAuth2, mit Scopes in Ihrer **FastAPI**-Anwendung verwalten.
/// warning | "Achtung"
/// warning | Achtung
Dies ist ein mehr oder weniger fortgeschrittener Abschnitt. Wenn Sie gerade erst anfangen, können Sie ihn überspringen.
@@ -88,7 +88,7 @@ Sehen wir uns zunächst kurz die Teile an, die sich gegenüber den Beispielen im
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -102,7 +102,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -116,7 +116,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -162,7 +162,7 @@ Der `scopes`-Parameter erhält ein `dict` mit jedem Scope als Schlüssel und des
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -176,7 +176,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -190,7 +190,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -218,7 +218,7 @@ Wir verwenden immer noch dasselbe `OAuth2PasswordRequestForm`. Es enthält eine
Und wir geben die Scopes als Teil des JWT-Tokens zurück.
/// danger | "Gefahr"
/// danger | Gefahr
Der Einfachheit halber fügen wir hier die empfangenen Scopes direkt zum Token hinzu.
@@ -252,7 +252,7 @@ Aus Sicherheitsgründen sollten Sie jedoch sicherstellen, dass Sie in Ihrer Anwe
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -266,7 +266,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -280,7 +280,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -308,7 +308,7 @@ Und die Abhängigkeitsfunktion `get_current_active_user` kann auch Unterabhängi
In diesem Fall erfordert sie den Scope `me` (sie könnte mehr als einen Scope erfordern).
/// note | "Hinweis"
/// note | Hinweis
Sie müssen nicht unbedingt an verschiedenen Stellen verschiedene Scopes hinzufügen.
@@ -342,7 +342,7 @@ Wir tun dies hier, um zu demonstrieren, wie **FastAPI** auf verschiedenen Ebenen
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -356,7 +356,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -370,7 +370,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -382,7 +382,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// info | "Technische Details"
/// info | Technische Details
`Security` ist tatsächlich eine Unterklasse von `Depends` und hat nur noch einen zusätzlichen Parameter, den wir später kennenlernen werden.
@@ -432,7 +432,7 @@ Diese `SecurityScopes`-Klasse ähnelt `Request` (`Request` wurde verwendet, um d
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -446,7 +446,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -460,7 +460,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -510,7 +510,7 @@ In diese Exception fügen wir (falls vorhanden) die erforderlichen Scopes als du
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -524,7 +524,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -538,7 +538,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -590,7 +590,7 @@ Wir verifizieren auch, dass wir einen Benutzer mit diesem Benutzernamen haben, u
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -604,7 +604,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -618,7 +618,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -662,7 +662,7 @@ Hierzu verwenden wir `security_scopes.scopes`, das eine `list`e mit allen diesen
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -676,7 +676,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -690,7 +690,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -727,7 +727,7 @@ So sieht die Hierarchie der Abhängigkeiten und Scopes aus:
* `security_scopes.scopes` enthält `["me"]` für die *Pfadoperation* `read_users_me`, da das in der Abhängigkeit `get_current_active_user` deklariert ist.
* `security_scopes.scopes` wird `[]` (nichts) für die *Pfadoperation* `read_system_status` enthalten, da diese keine `Security` mit `scopes` deklariert hat, und deren Abhängigkeit `get_current_user` ebenfalls keinerlei `scopes` deklariert.
/// tip | "Tipp"
/// tip | Tipp
Das Wichtige und „Magische“ hier ist, dass `get_current_user` für jede *Pfadoperation* eine andere Liste von `scopes` hat, die überprüft werden.
@@ -771,7 +771,7 @@ Am häufigsten ist der „Implicit“-Flow.
Am sichersten ist der „Code“-Flow, die Implementierung ist jedoch komplexer, da mehr Schritte erforderlich sind. Da er komplexer ist, schlagen viele Anbieter letztendlich den „Implicit“-Flow vor.
/// note | "Hinweis"
/// note | Hinweis
Es ist üblich, dass jeder Authentifizierungsanbieter seine Flows anders benennt, um sie zu einem Teil seiner Marke zu machen.

View File

@@ -8,7 +8,7 @@ Aus diesem Grund werden diese üblicherweise in Umgebungsvariablen bereitgestell
## Umgebungsvariablen
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie bereits wissen, was „Umgebungsvariablen“ sind und wie man sie verwendet, können Sie gerne mit dem nächsten Abschnitt weiter unten fortfahren.
@@ -67,7 +67,7 @@ name = os.getenv("MY_NAME", "World")
print(f"Hello {name} from Python")
```
/// tip | "Tipp"
/// tip | Tipp
Das zweite Argument für <a href="https://docs.python.org/3.8/library/os.html#os.getenv" class="external-link" target="_blank">`os.getenv()`</a> ist der zurückzugebende Defaultwert.
@@ -124,7 +124,7 @@ Hello World from Python
</div>
/// tip | "Tipp"
/// tip | Tipp
Weitere Informationen dazu finden Sie unter <a href="https://12factor.net/config" class="external-link" target="_blank">The Twelve-Factor App: Config</a>.
@@ -200,7 +200,7 @@ In Pydantic v1 würden Sie `BaseSettings` direkt von `pydantic` statt von `pydan
////
/// tip | "Tipp"
/// tip | Tipp
Für ein schnelles Copy-and-paste verwenden Sie nicht dieses Beispiel, sondern das letzte unten.
@@ -232,7 +232,7 @@ $ ADMIN_EMAIL="deadpool@example.com" APP_NAME="ChimichangApp" uvicorn main:app
</div>
/// tip | "Tipp"
/// tip | Tipp
Um mehrere Umgebungsvariablen für einen einzelnen Befehl festzulegen, trennen Sie diese einfach durch ein Leerzeichen und fügen Sie alle vor dem Befehl ein.
@@ -260,7 +260,7 @@ Und dann verwenden Sie diese in einer Datei `main.py`:
{!../../docs_src/settings/app01/main.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Sie benötigen außerdem eine Datei `__init__.py`, wie in [Größere Anwendungen mehrere Dateien](../tutorial/bigger-applications.md){.internal-link target=_blank} gesehen.
@@ -304,7 +304,7 @@ Jetzt erstellen wir eine Abhängigkeit, die ein neues `config.Settings()` zurüc
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -316,7 +316,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// tip | "Tipp"
/// tip | Tipp
Wir werden das `@lru_cache` in Kürze besprechen.
@@ -344,7 +344,7 @@ Und dann können wir das von der *Pfadoperation-Funktion* als Abhängigkeit einf
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -374,7 +374,7 @@ Wenn Sie viele Einstellungen haben, die sich möglicherweise oft ändern, vielle
Diese Praxis ist so weit verbreitet, dass sie einen Namen hat. Diese Umgebungsvariablen werden üblicherweise in einer Datei `.env` abgelegt und die Datei wird „dotenv“ genannt.
/// tip | "Tipp"
/// tip | Tipp
Eine Datei, die mit einem Punkt (`.`) beginnt, ist eine versteckte Datei in Unix-ähnlichen Systemen wie Linux und macOS.
@@ -384,7 +384,7 @@ Aber eine dotenv-Datei muss nicht unbedingt genau diesen Dateinamen haben.
Pydantic unterstützt das Lesen dieser Dateitypen mithilfe einer externen Bibliothek. Weitere Informationen finden Sie unter <a href="https://docs.pydantic.dev/latest/concepts/pydantic_settings/#dotenv-env-support" class="external-link" target="_blank">Pydantic Settings: Dotenv (.env) support</a>.
/// tip | "Tipp"
/// tip | Tipp
Damit das funktioniert, müssen Sie `pip install python-dotenv` ausführen.
@@ -409,7 +409,7 @@ Und dann aktualisieren Sie Ihre `config.py` mit:
{!> ../../docs_src/settings/app03_an/config.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Das Attribut `model_config` wird nur für die Pydantic-Konfiguration verwendet. Weitere Informationen finden Sie unter <a href="https://docs.pydantic.dev/latest/concepts/config/" class="external-link" target="_blank">Pydantic: Configuration</a>.
@@ -423,7 +423,7 @@ Das Attribut `model_config` wird nur für die Pydantic-Konfiguration verwendet.
{!> ../../docs_src/settings/app03_an/config_pv1.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Die Klasse `Config` wird nur für die Pydantic-Konfiguration verwendet. Weitere Informationen finden Sie unter <a href="https://docs.pydantic.dev/1.10/usage/model_config/" class="external-link" target="_blank">Pydantic Model Config</a>.
@@ -480,7 +480,7 @@ Da wir jedoch den `@lru_cache`-Dekorator oben verwenden, wird das `Settings`-Obj
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.

View File

@@ -31,7 +31,7 @@ $ pip install jinja2
{!../../docs_src/templates/tutorial001.py!}
```
/// note | "Hinweis"
/// note | Hinweis
Vor FastAPI 0.108.0 und Starlette 0.29.0 war `name` der erste Parameter.
@@ -39,13 +39,13 @@ Außerdem wurde in früheren Versionen das `request`-Objekt als Teil der Schlüs
///
/// tip | "Tipp"
/// tip | Tipp
Durch die Deklaration von `response_class=HTMLResponse` kann die Dokumentationsoberfläche erkennen, dass die Response HTML sein wird.
///
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette.templating import Jinja2Templates` verwenden.

View File

@@ -54,7 +54,7 @@ Und dann ruft **FastAPI** diese Überschreibung anstelle der ursprünglichen Abh
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -68,7 +68,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -80,7 +80,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// tip | "Tipp"
/// tip | Tipp
Sie können eine Überschreibung für eine Abhängigkeit festlegen, die an einer beliebigen Stelle in Ihrer **FastAPI**-Anwendung verwendet wird.
@@ -96,7 +96,7 @@ Anschließend können Sie Ihre Überschreibungen zurücksetzen (entfernen), inde
app.dependency_overrides = {}
```
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie eine Abhängigkeit nur während einiger Tests überschreiben möchten, können Sie die Überschreibung zu Beginn des Tests (innerhalb der Testfunktion) festlegen und am Ende (am Ende der Testfunktion) zurücksetzen.

View File

@@ -8,7 +8,7 @@ Dazu verwenden Sie den `TestClient` in einer `with`-Anweisung, eine Verbindung z
{!../../docs_src/app_testing/tutorial002.py!}
```
/// note | "Hinweis"
/// note | Hinweis
Weitere Informationen finden Sie in der Starlette-Dokumentation zum <a href="https://www.starlette.io/testclient/#testing-websocket-sessions" class="external-link" target="_blank">Testen von WebSockets</a>.

View File

@@ -35,7 +35,7 @@ Dazu müssen Sie direkt auf den Request zugreifen.
Durch die Deklaration eines *Pfadoperation-Funktionsparameters*, dessen Typ der `Request` ist, weiß **FastAPI**, dass es den `Request` diesem Parameter übergeben soll.
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass wir in diesem Fall einen Pfad-Parameter zusätzlich zum Request-Parameter deklarieren.
@@ -49,7 +49,7 @@ Auf die gleiche Weise können Sie wie gewohnt jeden anderen Parameter deklariere
Weitere Details zum <a href="https://www.starlette.io/requests/" class="external-link" target="_blank">`Request`-Objekt finden Sie in der offiziellen Starlette-Dokumentation</a>.
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette.requests import Request` verwenden.

View File

@@ -50,7 +50,7 @@ Erstellen Sie in Ihrer **FastAPI**-Anwendung einen `websocket`:
{!../../docs_src/websockets/tutorial001.py!}
```
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette.websockets import WebSocket` verwenden.
@@ -141,7 +141,7 @@ Diese funktionieren auf die gleiche Weise wie für andere FastAPI-Endpunkte/*Pfa
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -155,7 +155,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -196,7 +196,7 @@ Dort können Sie einstellen:
* Die „Item ID“, die im Pfad verwendet wird.
* Das „Token“, das als Query-Parameter verwendet wird.
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass der Query-„Token“ von einer Abhängigkeit verarbeitet wird.
@@ -238,7 +238,7 @@ Das wird die Ausnahme `WebSocketDisconnect` auslösen und alle anderen Clients e
Client #1596980209979 left the chat
```
/// tip | "Tipp"
/// tip | Tipp
Die obige Anwendung ist ein minimales und einfaches Beispiel, das zeigt, wie Nachrichten verarbeitet und an mehrere WebSocket-Verbindungen gesendet werden.

View File

@@ -30,13 +30,13 @@ Es wird von vielen Unternehmen verwendet, darunter Mozilla, Red Hat und Eventbri
Es war eines der ersten Beispiele für **automatische API-Dokumentation**, und dies war insbesondere eine der ersten Ideen, welche „die Suche nach“ **FastAPI** inspirierten.
/// note | "Hinweis"
/// note | Hinweis
Das Django REST Framework wurde von Tom Christie erstellt. Derselbe Schöpfer von Starlette und Uvicorn, auf denen **FastAPI** basiert.
///
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
Eine automatische API-Dokumentationsoberfläche zu haben.
@@ -56,7 +56,7 @@ Diese Entkopplung der Teile und die Tatsache, dass es sich um ein „Mikroframew
Angesichts der Einfachheit von Flask schien es eine gute Ergänzung zum Erstellen von APIs zu sein. Als Nächstes musste ein „Django REST Framework“ für Flask gefunden werden.
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
Ein Mikroframework zu sein. Es einfach zu machen, die benötigten Tools und Teile zu kombinieren.
@@ -98,7 +98,7 @@ def read_url():
Sehen Sie sich die Ähnlichkeiten in `requests.get(...)` und `@app.get(...)` an.
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
* Über eine einfache und intuitive API zu verfügen.
* HTTP-Methodennamen (Operationen) direkt, auf einfache und intuitive Weise zu verwenden.
@@ -118,7 +118,7 @@ Irgendwann wurde Swagger an die Linux Foundation übergeben und in OpenAPI umben
Aus diesem Grund spricht man bei Version 2.0 häufig von „Swagger“ und ab Version 3 von „OpenAPI“.
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
Einen offenen Standard für API-Spezifikationen zu übernehmen und zu verwenden, anstelle eines benutzerdefinierten Schemas.
@@ -147,7 +147,7 @@ Für diese Funktionen wurde Marshmallow entwickelt. Es ist eine großartige Bibl
Aber sie wurde erstellt, bevor Typhinweise in Python existierten. Um also ein <abbr title="die Definition, wie Daten geformt sein werden sollen">Schema</abbr> zu definieren, müssen Sie bestimmte Werkzeuge und Klassen verwenden, die von Marshmallow bereitgestellt werden.
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
Code zu verwenden, um „Schemas“ zu definieren, welche Datentypen und Validierung automatisch bereitstellen.
@@ -169,7 +169,7 @@ Webargs wurde von denselben Marshmallow-Entwicklern erstellt.
///
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
Eingehende Requestdaten automatisch zu validieren.
@@ -199,7 +199,7 @@ APISpec wurde von denselben Marshmallow-Entwicklern erstellt.
///
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
Den offenen Standard für APIs, OpenAPI, zu unterstützen.
@@ -231,7 +231,7 @@ Flask-apispec wurde von denselben Marshmallow-Entwicklern erstellt.
///
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
Das OpenAPI-Schema automatisch zu generieren, aus demselben Code, welcher die Serialisierung und Validierung definiert.
@@ -251,7 +251,7 @@ Da TypeScript-Daten jedoch nach der Kompilierung nach JavaScript nicht erhalten
Es kann nicht sehr gut mit verschachtelten Modellen umgehen. Wenn es sich beim JSON-Body in der Anfrage also um ein JSON-Objekt mit inneren Feldern handelt, die wiederum verschachtelte JSON-Objekte sind, kann er nicht richtig dokumentiert und validiert werden.
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
Python-Typen zu verwenden, um eine hervorragende Editorunterstützung zu erhalten.
@@ -263,7 +263,7 @@ Python-Typen zu verwenden, um eine hervorragende Editorunterstützung zu erhalte
Es war eines der ersten extrem schnellen Python-Frameworks, welches auf `asyncio` basierte. Es wurde so gestaltet, dass es Flask sehr ähnlich ist.
/// note | "Technische Details"
/// note | Technische Details
Es verwendete <a href="https://github.com/MagicStack/uvloop" class="external-link" target="_blank">`uvloop`</a> anstelle der standardmäßigen Python-`asyncio`-Schleife. Das hat es so schnell gemacht.
@@ -271,7 +271,7 @@ Hat eindeutig Uvicorn und Starlette inspiriert, welche derzeit in offenen Benchm
///
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
Einen Weg zu finden, eine hervorragende Performanz zu haben.
@@ -287,7 +287,7 @@ Es ist so konzipiert, dass es über Funktionen verfügt, welche zwei Parameter e
Daher müssen Datenvalidierung, Serialisierung und Dokumentation im Code und nicht automatisch erfolgen. Oder sie müssen als Framework oberhalb von Falcon implementiert werden, so wie Hug. Dieselbe Unterscheidung findet auch in anderen Frameworks statt, die vom Design von Falcon inspiriert sind und ein Requestobjekt und ein Responseobjekt als Parameter haben.
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
Wege zu finden, eine großartige Performanz zu erzielen.
@@ -313,7 +313,7 @@ Das Dependency Injection System erfordert eine Vorab-Registrierung der Abhängig
Routen werden an einer einzigen Stelle deklariert, indem Funktionen verwendet werden, die an anderen Stellen deklariert wurden (anstatt Dekoratoren zu verwenden, welche direkt über der Funktion platziert werden können, welche den Endpunkt verarbeitet). Dies ähnelt eher der Vorgehensweise von Django als der Vorgehensweise von Flask (und Starlette). Es trennt im Code Dinge, die relativ eng miteinander gekoppelt sind.
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
Zusätzliche Validierungen für Datentypen zu definieren, mithilfe des „Default“-Werts von Modellattributen. Dies verbessert die Editorunterstützung und war zuvor in Pydantic nicht verfügbar.
@@ -341,7 +341,7 @@ Hug wurde von Timothy Crosley erstellt, dem gleichen Schöpfer von <a href="http
///
/// check | "Ideen, die **FastAPI** inspiriert haben"
/// check | Ideen, die **FastAPI** inspiriert haben
Hug inspirierte Teile von APIStar und war eines der Tools, die ich am vielversprechendsten fand, neben APIStar.
@@ -385,7 +385,7 @@ APIStar wurde von Tom Christie erstellt. Derselbe, welcher Folgendes erstellt ha
///
/// check | "Inspirierte **FastAPI**"
/// check | Inspirierte **FastAPI**
Zu existieren.
@@ -409,7 +409,7 @@ Das macht es äußerst intuitiv.
Es ist vergleichbar mit Marshmallow. Obwohl es in Benchmarks schneller als Marshmallow ist. Und da es auf den gleichen Python-Typhinweisen basiert, ist die Editorunterstützung großartig.
/// check | "**FastAPI** verwendet es, um"
/// check | **FastAPI** verwendet es, um
Die gesamte Datenvalidierung, Datenserialisierung und automatische Modelldokumentation (basierend auf JSON Schema) zu erledigen.
@@ -444,7 +444,7 @@ Es bietet jedoch keine automatische Datenvalidierung, Serialisierung oder Dokume
Das ist eines der wichtigsten Dinge, welche **FastAPI** hinzufügt, alles basierend auf Python-Typhinweisen (mit Pydantic). Das, plus, das Dependency Injection System, Sicherheitswerkzeuge, OpenAPI-Schemagenerierung, usw.
/// note | "Technische Details"
/// note | Technische Details
ASGI ist ein neuer „Standard“, welcher von Mitgliedern des Django-Kernteams entwickelt wird. Es handelt sich immer noch nicht um einen „Python-Standard“ (ein PEP), obwohl sie gerade dabei sind, das zu tun.
@@ -452,7 +452,7 @@ Dennoch wird es bereits von mehreren Tools als „Standard“ verwendet. Das ver
///
/// check | "**FastAPI** verwendet es, um"
/// check | **FastAPI** verwendet es, um
Alle Kern-Webaspekte zu handhaben. Und fügt Funktionen obenauf.
@@ -470,7 +470,7 @@ Es handelt sich nicht um ein Webframework, sondern um einen Server. Beispielswei
Es ist der empfohlene Server für Starlette und **FastAPI**.
/// check | "**FastAPI** empfiehlt es als"
/// check | **FastAPI** empfiehlt es als
Hauptwebserver zum Ausführen von **FastAPI**-Anwendungen.

View File

@@ -401,7 +401,7 @@ All das ist es, was FastAPI (via Starlette) befeuert und es eine so beeindrucken
## Sehr technische Details
/// warning | "Achtung"
/// warning | Achtung
Das folgende können Sie wahrscheinlich überspringen.

View File

@@ -1,484 +0,0 @@
# Entwicklung Mitwirken
Vielleicht möchten Sie sich zuerst die grundlegenden Möglichkeiten anschauen, [FastAPI zu helfen und Hilfe zu erhalten](help-fastapi.md){.internal-link target=_blank}.
## Entwicklung
Wenn Sie das <a href="https://github.com/fastapi/fastapi" class="external-link" target="_blank">fastapi Repository</a> bereits geklont haben und tief in den Code eintauchen möchten, hier einen Leitfaden zum Einrichten Ihrer Umgebung.
### Virtuelle Umgebung mit `venv`
Sie können mit dem Python-Modul `venv` in einem Verzeichnis eine isolierte virtuelle lokale Umgebung erstellen. Machen wir das im geklonten Repository (da wo sich die `requirements.txt` befindet):
<div class="termy">
```console
$ python -m venv env
```
</div>
Das erstellt ein Verzeichnis `./env/` mit den Python-Binärdateien und Sie können dann Packages in dieser lokalen Umgebung installieren.
### Umgebung aktivieren
Aktivieren Sie die neue Umgebung mit:
//// tab | Linux, macOS
<div class="termy">
```console
$ source ./env/bin/activate
```
</div>
////
//// tab | Windows PowerShell
<div class="termy">
```console
$ .\env\Scripts\Activate.ps1
```
</div>
////
//// tab | Windows Bash
Oder, wenn Sie Bash für Windows verwenden (z. B. <a href="https://gitforwindows.org/" class="external-link" target="_blank">Git Bash</a>):
<div class="termy">
```console
$ source ./env/Scripts/activate
```
</div>
////
Um zu überprüfen, ob es funktioniert hat, geben Sie ein:
//// tab | Linux, macOS, Windows Bash
<div class="termy">
```console
$ which pip
some/directory/fastapi/env/bin/pip
```
</div>
////
//// tab | Windows PowerShell
<div class="termy">
```console
$ Get-Command pip
some/directory/fastapi/env/bin/pip
```
</div>
////
Wenn die `pip` Binärdatei unter `env/bin/pip` angezeigt wird, hat es funktioniert. 🎉
Stellen Sie sicher, dass Sie über die neueste Version von pip in Ihrer lokalen Umgebung verfügen, um Fehler bei den nächsten Schritten zu vermeiden:
<div class="termy">
```console
$ python -m pip install --upgrade pip
---> 100%
```
</div>
/// tip | "Tipp"
Aktivieren Sie jedes Mal, wenn Sie ein neues Package mit `pip` in dieser Umgebung installieren, die Umgebung erneut.
Dadurch wird sichergestellt, dass Sie, wenn Sie ein von diesem Package installiertes Terminalprogramm verwenden, das Programm aus Ihrer lokalen Umgebung verwenden und kein anderes, das global installiert sein könnte.
///
### Benötigtes mit pip installieren
Nachdem Sie die Umgebung wie oben beschrieben aktiviert haben:
<div class="termy">
```console
$ pip install -r requirements.txt
---> 100%
```
</div>
Das installiert alle Abhängigkeiten und Ihr lokales FastAPI in Ihrer lokalen Umgebung.
#### Das lokale FastAPI verwenden
Wenn Sie eine Python-Datei erstellen, die FastAPI importiert und verwendet, und diese mit dem Python aus Ihrer lokalen Umgebung ausführen, wird Ihr geklonter lokaler FastAPI-Quellcode verwendet.
Und wenn Sie diesen lokalen FastAPI-Quellcode aktualisieren und dann die Python-Datei erneut ausführen, wird die neue Version von FastAPI verwendet, die Sie gerade bearbeitet haben.
Auf diese Weise müssen Sie Ihre lokale Version nicht „installieren“, um jede Änderung testen zu können.
/// note | "Technische Details"
Das geschieht nur, wenn Sie die Installation mit der enthaltenen `requirements.txt` durchführen, anstatt `pip install fastapi` direkt auszuführen.
Das liegt daran, dass in der Datei `requirements.txt` die lokale Version von FastAPI mit der Option `-e` für die Installation im „editierbaren“ Modus markiert ist.
///
### Den Code formatieren
Es gibt ein Skript, das, wenn Sie es ausführen, Ihren gesamten Code formatiert und bereinigt:
<div class="termy">
```console
$ bash scripts/format.sh
```
</div>
Es sortiert auch alle Ihre Importe automatisch.
Damit es sie richtig sortiert, muss FastAPI lokal in Ihrer Umgebung installiert sein, mit dem Befehl vom obigen Abschnitt, welcher `-e` verwendet.
## Dokumentation
Stellen Sie zunächst sicher, dass Sie Ihre Umgebung wie oben beschrieben einrichten, was alles Benötigte installiert.
### Dokumentation live
Während der lokalen Entwicklung gibt es ein Skript, das die Site erstellt, auf Änderungen prüft und direkt neu lädt (Live Reload):
<div class="termy">
```console
$ python ./scripts/docs.py live
<span style="color: green;">[INFO]</span> Serving on http://127.0.0.1:8008
<span style="color: green;">[INFO]</span> Start watching changes
<span style="color: green;">[INFO]</span> Start detecting changes
```
</div>
Das stellt die Dokumentation unter `http://127.0.0.1:8008` bereit.
Auf diese Weise können Sie die Dokumentation/Quelldateien bearbeiten und die Änderungen live sehen.
/// tip | "Tipp"
Alternativ können Sie die Schritte des Skripts auch manuell ausführen.
Gehen Sie in das Verzeichnis für die entsprechende Sprache. Das für die englischsprachige Hauptdokumentation befindet sich unter `docs/en/`:
```console
$ cd docs/en/
```
Führen Sie dann `mkdocs` in diesem Verzeichnis aus:
```console
$ mkdocs serve --dev-addr 8008
```
///
#### Typer-CLI (optional)
Die Anleitung hier zeigt Ihnen, wie Sie das Skript unter `./scripts/docs.py` direkt mit dem `python` Programm verwenden.
Sie können aber auch <a href="https://typer.tiangolo.com/typer-cli/" class="external-link" target="_blank">Typer CLI</a> verwenden und erhalten dann Autovervollständigung für Kommandos in Ihrem Terminal, nach dem Sie dessen Vervollständigung installiert haben.
Wenn Sie Typer CLI installieren, können Sie die Vervollständigung installieren mit:
<div class="termy">
```console
$ typer --install-completion
zsh completion installed in /home/user/.bashrc.
Completion will take effect once you restart the terminal.
```
</div>
### Dokumentationsstruktur
Die Dokumentation verwendet <a href="https://www.mkdocs.org/" class="external-link" target="_blank">MkDocs</a>.
Und es gibt zusätzliche Tools/Skripte für Übersetzungen, in `./scripts/docs.py`.
/// tip | "Tipp"
Sie müssen sich den Code in `./scripts/docs.py` nicht anschauen, verwenden Sie ihn einfach in der Kommandozeile.
///
Die gesamte Dokumentation befindet sich im Markdown-Format im Verzeichnis `./docs/en/`.
Viele der Tutorials enthalten Codeblöcke.
In den meisten Fällen handelt es sich bei diesen Codeblöcken um vollständige Anwendungen, die unverändert ausgeführt werden können.
Tatsächlich sind diese Codeblöcke nicht Teil des Markdowns, sondern Python-Dateien im Verzeichnis `./docs_src/`.
Und diese Python-Dateien werden beim Generieren der Site in die Dokumentation eingefügt.
### Dokumentation für Tests
Tatsächlich arbeiten die meisten Tests mit den Beispielquelldateien in der Dokumentation.
Dadurch wird sichergestellt, dass:
* Die Dokumentation aktuell ist.
* Die Dokumentationsbeispiele ohne Änderung ausgeführt werden können.
* Die meisten Funktionalitäten durch die Dokumentation abgedeckt werden, sichergestellt durch die Testabdeckung.
#### Gleichzeitig Apps und Dokumentation
Wenn Sie die Beispiele ausführen, mit z. B.:
<div class="termy">
```console
$ uvicorn tutorial001:app --reload
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
```
</div>
wird das, da Uvicorn standardmäßig den Port `8000` verwendet, mit der Dokumentation auf dem Port `8008` nicht in Konflikt geraten.
### Übersetzungen
Hilfe bei Übersetzungen wird SEHR geschätzt! Und es kann nicht getan werden, ohne die Hilfe der Gemeinschaft. 🌎 🚀
Hier sind die Schritte, die Ihnen bei Übersetzungen helfen.
#### Tipps und Richtlinien
* Schauen Sie nach <a href="https://github.com/fastapi/fastapi/pulls" class="external-link" target="_blank">aktuellen Pull Requests</a> für Ihre Sprache. Sie können die Pull Requests nach dem Label für Ihre Sprache filtern. Für Spanisch lautet das Label beispielsweise <a href="https://github.com/fastapi/fastapi/pulls?q=is%3Aopen+sort%3Aupdated-desc+label%3Alang-es+label%3Aawaiting-review" class="external-link" target="_blank">`lang-es`</a>.
* Sehen Sie diese Pull Requests durch (Review), schlagen Sie Änderungen vor, oder segnen Sie sie ab (Approval). Bei den Sprachen, die ich nicht spreche, warte ich, bis mehrere andere die Übersetzung durchgesehen haben, bevor ich den Pull Request merge.
/// tip | "Tipp"
Sie können <a href="https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request" class="external-link" target="_blank">Kommentare mit Änderungsvorschlägen</a> zu vorhandenen Pull Requests hinzufügen.
Schauen Sie sich die Dokumentation an, <a href="https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews" class="external-link" target="_blank">wie man ein Review zu einem Pull Request hinzufügt</a>, welches den PR absegnet oder Änderungen vorschlägt.
///
* Überprüfen Sie, ob es eine <a href="https://github.com/fastapi/fastapi/discussions/categories/translations" class="external-link" target="_blank">GitHub-Diskussion</a> gibt, die Übersetzungen für Ihre Sprache koordiniert. Sie können sie abonnieren, und wenn ein neuer Pull Request zum Review vorliegt, wird der Diskussion automatisch ein Kommentar hinzugefügt.
* Wenn Sie Seiten übersetzen, fügen Sie einen einzelnen Pull Request pro übersetzter Seite hinzu. Dadurch wird es für andere viel einfacher, ihn zu durchzusehen.
* Um den Zwei-Buchstaben-Code für die Sprache zu finden, die Sie übersetzen möchten, schauen Sie sich die Tabelle <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" class="external-link" target= verwenden "_blank">List of ISO 639-1 codes</a> an.
#### Vorhandene Sprache
Angenommen, Sie möchten eine Seite für eine Sprache übersetzen, die bereits Übersetzungen für einige Seiten hat, beispielsweise für Spanisch.
Im Spanischen lautet der Zwei-Buchstaben-Code `es`. Das Verzeichnis für spanische Übersetzungen befindet sich also unter `docs/es/`.
/// tip | "Tipp"
Die Haupt („offizielle“) Sprache ist Englisch und befindet sich unter `docs/en/`.
///
Führen Sie nun den Live-Server für die Dokumentation auf Spanisch aus:
<div class="termy">
```console
// Verwenden Sie das Kommando „live“ und fügen Sie den Sprach-Code als Argument hinten an
$ python ./scripts/docs.py live es
<span style="color: green;">[INFO]</span> Serving on http://127.0.0.1:8008
<span style="color: green;">[INFO]</span> Start watching changes
<span style="color: green;">[INFO]</span> Start detecting changes
```
</div>
/// tip | "Tipp"
Alternativ können Sie die Schritte des Skripts auch manuell ausführen.
Gehen Sie in das Sprachverzeichnis, für die spanischen Übersetzungen ist das `docs/es/`:
```console
$ cd docs/es/
```
Dann führen Sie in dem Verzeichnis `mkdocs` aus:
```console
$ mkdocs serve --dev-addr 8008
```
///
Jetzt können Sie auf <a href="http://127.0.0.1:8008" class="external-link" target="_blank">http://127.0.0.1:8008</a> gehen und Ihre Änderungen live sehen.
Sie werden sehen, dass jede Sprache alle Seiten hat. Einige Seiten sind jedoch nicht übersetzt und haben oben eine Info-Box, dass die Übersetzung noch fehlt.
Nehmen wir nun an, Sie möchten eine Übersetzung für den Abschnitt [Features](features.md){.internal-link target=_blank} hinzufügen.
* Kopieren Sie die Datei:
```
docs/en/docs/features.md
```
* Fügen Sie sie an genau derselben Stelle ein, jedoch für die Sprache, die Sie übersetzen möchten, z. B.:
```
docs/es/docs/features.md
```
/// tip | "Tipp"
Beachten Sie, dass die einzige Änderung in Pfad und Dateiname der Sprachcode ist, von `en` zu `es`.
///
Wenn Sie in Ihrem Browser nachsehen, werden Sie feststellen, dass die Dokumentation jetzt Ihren neuen Abschnitt anzeigt (die Info-Box oben ist verschwunden). 🎉
Jetzt können Sie alles übersetzen und beim Speichern sehen, wie es aussieht.
#### Neue Sprache
Nehmen wir an, Sie möchten Übersetzungen für eine Sprache hinzufügen, die noch nicht übersetzt ist, nicht einmal einige Seiten.
Angenommen, Sie möchten Übersetzungen für Kreolisch hinzufügen, diese sind jedoch noch nicht in den Dokumenten enthalten.
Wenn Sie den Link von oben überprüfen, lautet der Sprachcode für Kreolisch `ht`.
Der nächste Schritt besteht darin, das Skript auszuführen, um ein neues Übersetzungsverzeichnis zu erstellen:
<div class="termy">
```console
// Verwenden Sie das Kommando new-lang und fügen Sie den Sprach-Code als Argument hinten an
$ python ./scripts/docs.py new-lang ht
Successfully initialized: docs/ht
```
</div>
Jetzt können Sie in Ihrem Code-Editor das neu erstellte Verzeichnis `docs/ht/` sehen.
Obiges Kommando hat eine Datei `docs/ht/mkdocs.yml` mit einer Minimal-Konfiguration erstellt, die alles von der `en`-Version erbt:
```yaml
INHERIT: ../en/mkdocs.yml
```
/// tip | "Tipp"
Sie können diese Datei mit diesem Inhalt auch einfach manuell erstellen.
///
Das Kommando hat auch eine Dummy-Datei `docs/ht/index.md` für die Hauptseite erstellt. Sie können mit der Übersetzung dieser Datei beginnen.
Sie können nun mit den obigen Instruktionen für eine „vorhandene Sprache“ fortfahren.
Fügen Sie dem ersten Pull Request beide Dateien `docs/ht/mkdocs.yml` und `docs/ht/index.md` bei. 🎉
#### Vorschau des Ergebnisses
Wie bereits oben erwähnt, können Sie `./scripts/docs.py` mit dem Befehl `live` verwenden, um eine Vorschau der Ergebnisse anzuzeigen (oder `mkdocs serve`).
Sobald Sie fertig sind, können Sie auch alles so testen, wie es online aussehen würde, einschließlich aller anderen Sprachen.
Bauen Sie dazu zunächst die gesamte Dokumentation:
<div class="termy">
```console
// Verwenden Sie das Kommando „build-all“, das wird ein wenig dauern
$ python ./scripts/docs.py build-all
Building docs for: en
Building docs for: es
Successfully built docs for: es
```
</div>
Dadurch werden alle diese unabhängigen MkDocs-Sites für jede Sprache erstellt, kombiniert und das endgültige Resultat unter `./site/` gespeichert.
Dieses können Sie dann mit dem Befehl `serve` bereitstellen:
<div class="termy">
```console
// Verwenden Sie das Kommando „serve“ nachdem Sie „build-all“ ausgeführt haben.
$ python ./scripts/docs.py serve
Warning: this is a very simple server. For development, use mkdocs serve instead.
This is here only to preview a site with translations already built.
Make sure you run the build-all command first.
Serving at: http://127.0.0.1:8008
```
</div>
#### Übersetzungsspezifische Tipps und Richtlinien
* Übersetzen Sie nur die Markdown-Dokumente (`.md`). Übersetzen Sie nicht die Codebeispiele unter `./docs_src`.
* In Codeblöcken innerhalb des Markdown-Dokuments, übersetzen Sie Kommentare (`# ein Kommentar`), aber lassen Sie den Rest unverändert.
* Ändern Sie nichts, was in "``" (Inline-Code) eingeschlossen ist.
* In Zeilen, die mit `===` oder `!!!` beginnen, übersetzen Sie nur den ` "... Text ..."`-Teil. Lassen Sie den Rest unverändert.
* Sie können Info-Boxen wie `!!! warning` mit beispielsweise `!!! warning "Achtung"` übersetzen. Aber ändern Sie nicht das Wort direkt nach dem `!!!`, es bestimmt die Farbe der Info-Box.
* Ändern Sie nicht die Pfade in Links zu Bildern, Codedateien, Markdown Dokumenten.
* Wenn ein Markdown-Dokument übersetzt ist, ändern sich allerdings unter Umständen die `#hash-teile` in Links zu dessen Überschriften. Aktualisieren Sie diese Links, wenn möglich.
* Suchen Sie im übersetzten Dokument nach solchen Links mit dem Regex `#[^# ]`.
* Suchen Sie in allen bereits in ihre Sprache übersetzen Dokumenten nach `ihr-ubersetztes-dokument.md`. VS Code hat beispielsweise eine Option „Bearbeiten“ -> „In Dateien suchen“.
* Übersetzen Sie bei der Übersetzung eines Dokuments nicht „im Voraus“ `#hash-teile`, die zu Überschriften in noch nicht übersetzten Dokumenten verlinken.
## Tests
Es gibt ein Skript, das Sie lokal ausführen können, um den gesamten Code zu testen und Code Coverage Reporte in HTML zu generieren:
<div class="termy">
```console
$ bash scripts/test-cov-html.sh
```
</div>
Dieses Kommando generiert ein Verzeichnis `./htmlcov/`. Wenn Sie die Datei `./htmlcov/index.html` in Ihrem Browser öffnen, können Sie interaktiv die Codebereiche erkunden, die von den Tests abgedeckt werden, und feststellen, ob Bereiche fehlen.

View File

@@ -151,7 +151,7 @@ Und dennoch möchten Sie wahrscheinlich nicht, dass die Anwendung tot bleibt, we
Aber in den Fällen mit wirklich schwerwiegenden Fehlern, die den laufenden **Prozess** zum Absturz bringen, benötigen Sie eine externe Komponente, die den Prozess **neu startet**, zumindest ein paar Mal ...
/// tip | "Tipp"
/// tip | Tipp
... Obwohl es wahrscheinlich keinen Sinn macht, sie immer wieder neu zu starten, wenn die gesamte Anwendung einfach **sofort abstürzt**. Aber in diesen Fällen werden Sie es wahrscheinlich während der Entwicklung oder zumindest direkt nach dem Deployment bemerken.
@@ -241,7 +241,7 @@ Hier sind einige mögliche Kombinationen und Strategien:
* **Cloud-Dienste**, welche das für Sie erledigen
* Der Cloud-Dienst wird wahrscheinlich **die Replikation für Sie übernehmen**. Er würde Sie möglicherweise **einen auszuführenden Prozess** oder ein **zu verwendendes Container-Image** definieren lassen, in jedem Fall wäre es höchstwahrscheinlich **ein einzelner Uvicorn-Prozess**, und der Cloud-Dienst wäre auch verantwortlich für die Replikation.
/// tip | "Tipp"
/// tip | Tipp
Machen Sie sich keine Sorgen, wenn einige dieser Punkte zu **Containern**, Docker oder Kubernetes noch nicht viel Sinn ergeben.
@@ -263,7 +263,7 @@ Und Sie müssen sicherstellen, dass es sich um einen einzelnen Prozess handelt,
Natürlich gibt es Fälle, in denen es kein Problem darstellt, die Vorab-Schritte mehrmals auszuführen. In diesem Fall ist die Handhabung viel einfacher.
/// tip | "Tipp"
/// tip | Tipp
Bedenken Sie außerdem, dass Sie, abhängig von Ihrer Einrichtung, in manchen Fällen **gar keine Vorab-Schritte** benötigen, bevor Sie die Anwendung starten.
@@ -281,7 +281,7 @@ Hier sind einige mögliche Ideen:
* Ein Bash-Skript, das die Vorab-Schritte ausführt und dann Ihre Anwendung startet
* Sie benötigen immer noch eine Möglichkeit, *dieses* Bash-Skript zu starten/neu zu starten, Fehler zu erkennen, usw.
/// tip | "Tipp"
/// tip | Tipp
Konkretere Beispiele hierfür mit Containern gebe ich Ihnen in einem späteren Kapitel: [FastAPI in Containern Docker](docker.md){.internal-link target=_blank}.

View File

@@ -4,7 +4,7 @@ Beim Deployment von FastAPI-Anwendungen besteht ein gängiger Ansatz darin, ein
Die Verwendung von Linux-Containern bietet mehrere Vorteile, darunter **Sicherheit**, **Replizierbarkeit**, **Einfachheit** und andere.
/// tip | "Tipp"
/// tip | Tipp
Sie haben es eilig und kennen sich bereits aus? Springen Sie zum [`Dockerfile` unten 👇](#ein-docker-image-fur-fastapi-erstellen).
@@ -231,7 +231,7 @@ CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80"]
Da das Programm unter `/code` gestartet wird und sich darin das Verzeichnis `./app` mit Ihrem Code befindet, kann **Uvicorn** `app` sehen und aus `app.main` **importieren**.
/// tip | "Tipp"
/// tip | Tipp
Lernen Sie, was jede Zeile bewirkt, indem Sie auf die Zahlenblasen im Code klicken. 👆
@@ -305,7 +305,7 @@ $ docker build -t myimage .
</div>
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie das `.` am Ende, es entspricht `./` und teilt Docker mit, welches Verzeichnis zum Erstellen des Containerimages verwendet werden soll.
@@ -409,7 +409,7 @@ Wenn wir uns nur auf das **Containerimage** für eine FastAPI-Anwendung (und sp
Es könnte sich um einen anderen Container handeln, zum Beispiel mit <a href="https://traefik.io/" class="external-link" target="_blank">Traefik</a>, welcher **HTTPS** und **automatischen** Erwerb von **Zertifikaten** handhabt.
/// tip | "Tipp"
/// tip | Tipp
Traefik verfügt über Integrationen mit Docker, Kubernetes und anderen, sodass Sie damit ganz einfach HTTPS für Ihre Container einrichten und konfigurieren können.
@@ -441,7 +441,7 @@ Bei der Verwendung von Containern ist normalerweise eine Komponente vorhanden, *
Da diese Komponente die **Last** an Requests aufnehmen und diese (hoffentlich) **ausgewogen** auf die Worker verteilen würde, wird sie üblicherweise auch **Load Balancer** Lastverteiler genannt.
/// tip | "Tipp"
/// tip | Tipp
Die gleiche **TLS-Terminierungsproxy**-Komponente, die für HTTPS verwendet wird, wäre wahrscheinlich auch ein **Load Balancer**.
@@ -544,7 +544,7 @@ Dieses Image wäre vor allem in den oben beschriebenen Situationen nützlich: [C
* <a href="https://github.com/tiangolo/uvicorn-gunicorn-fastapi-docker" class="external-link" target="_blank">tiangolo/uvicorn-gunicorn-fastapi</a>.
/// warning | "Achtung"
/// warning | Achtung
Es besteht eine hohe Wahrscheinlichkeit, dass Sie dieses oder ein ähnliches Basisimage **nicht** benötigen und es besser wäre, wenn Sie das Image von Grund auf neu erstellen würden, wie [oben beschrieben in: Ein Docker-Image für FastAPI erstellen](#ein-docker-image-fur-fastapi-erstellen).
@@ -556,7 +556,7 @@ Es verfügt über **vernünftige Standardeinstellungen**, aber Sie können trotz
Es unterstützt auch die Ausführung von <a href="https://github.com/tiangolo/uvicorn-gunicorn-fastapi-docker#pre_start_path" class="external-link" target="_blank">**Vorab-Schritten vor dem Start** </a> mit einem Skript.
/// tip | "Tipp"
/// tip | Tipp
Um alle Konfigurationen und Optionen anzuzeigen, gehen Sie zur Docker-Image-Seite: <a href="https://github.com/tiangolo/uvicorn-gunicorn-fastapi-docker" class="external-link" target="_blank">tiangolo/uvicorn-gunicorn-fastapi</a>.
@@ -687,7 +687,7 @@ CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80"]
11. Führe den Befehl `uvicorn` aus und weise ihn an, das aus `app.main` importierte `app`-Objekt zu verwenden.
/// tip | "Tipp"
/// tip | Tipp
Klicken Sie auf die Zahlenblasen, um zu sehen, was jede Zeile bewirkt.

View File

@@ -4,7 +4,7 @@ Es ist leicht anzunehmen, dass HTTPS etwas ist, was einfach nur „aktiviert“
Aber es ist viel komplexer als das.
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie es eilig haben oder es Ihnen egal ist, fahren Sie mit den nächsten Abschnitten fort, um Schritt-für-Schritt-Anleitungen für die Einrichtung der verschiedenen Technologien zu erhalten.
@@ -71,7 +71,7 @@ In dem oder den DNS-Server(n) würden Sie einen Eintrag (einen „`A record`“)
Sie würden dies wahrscheinlich nur einmal tun, beim ersten Mal, wenn Sie alles einrichten.
/// tip | "Tipp"
/// tip | Tipp
Dieser Domainnamen-Aspekt liegt weit vor HTTPS, aber da alles von der Domain und der IP-Adresse abhängt, lohnt es sich, das hier zu erwähnen.
@@ -121,7 +121,7 @@ Danach verfügen der Client und der Server über eine **verschlüsselte TCP-Verb
Und genau das ist **HTTPS**, es ist einfach **HTTP** innerhalb einer **sicheren TLS-Verbindung**, statt einer puren (unverschlüsselten) TCP-Verbindung.
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass die Verschlüsselung der Kommunikation auf der **TCP-Ebene** und nicht auf der HTTP-Ebene erfolgt.

View File

@@ -36,7 +36,7 @@ $ pip install "uvicorn[standard]"
</div>
/// tip | "Tipp"
/// tip | Tipp
Durch das Hinzufügen von `standard` installiert und verwendet Uvicorn einige empfohlene zusätzliche Abhängigkeiten.
@@ -96,7 +96,7 @@ Running on 0.0.0.0:8080 over http (CTRL + C to quit)
////
/// warning | "Achtung"
/// warning | Achtung
Denken Sie daran, die Option `--reload` zu entfernen, wenn Sie diese verwendet haben.

View File

@@ -42,7 +42,7 @@ Gemäß den Konventionen zur semantischen Versionierung könnte jede Version unt
FastAPI folgt auch der Konvention, dass jede „PATCH“-Versionsänderung für Bugfixes und abwärtskompatible Änderungen gedacht ist.
/// tip | "Tipp"
/// tip | Tipp
Der „PATCH“ ist die letzte Zahl, zum Beispiel ist in `0.2.3` die PATCH-Version `3`.
@@ -56,7 +56,7 @@ fastapi>=0.45.0,<0.46.0
Nicht abwärtskompatible Änderungen und neue Funktionen werden in „MINOR“-Versionen hinzugefügt.
/// tip | "Tipp"
/// tip | Tipp
„MINOR“ ist die Zahl in der Mitte, zum Beispiel ist in `0.2.3` die MINOR-Version `2`.

View File

@@ -228,7 +228,7 @@ Wenn Sie mir dabei helfen können, **helfen Sie mir, FastAPI am Laufen zu erhalt
Treten Sie dem 👥 <a href="https://discord.gg/VQjSZaeJmf" class="external-link" target="_blank">Discord-Chatserver</a> 👥 bei und treffen Sie sich mit anderen Mitgliedern der FastAPI-Community.
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie Fragen haben, stellen Sie sie bei <a href="https://github.com/fastapi/fastapi/discussions/new?category=questions" class="external-link" target="_blank">GitHub Diskussionen</a>, es besteht eine viel bessere Chance, dass Sie hier Hilfe von den [FastAPI-Experten](fastapi-people.md#experten){.internal-link target=_blank} erhalten.

View File

@@ -18,9 +18,7 @@ Ohne Änderung der Einstellungen ist die Syntaxhervorhebung standardmäßig akti
Sie können sie jedoch deaktivieren, indem Sie `syntaxHighlight` auf `False` setzen:
```Python hl_lines="3"
{!../../docs_src/configure_swagger_ui/tutorial001.py!}
```
{* ../../docs_src/configure_swagger_ui/tutorial001.py hl[3] *}
... und dann zeigt die Swagger-Oberfläche die Syntaxhervorhebung nicht mehr an:
@@ -30,9 +28,7 @@ Sie können sie jedoch deaktivieren, indem Sie `syntaxHighlight` auf `False` set
Auf die gleiche Weise könnten Sie das Theme der Syntaxhervorhebung mit dem Schlüssel `syntaxHighlight.theme` festlegen (beachten Sie, dass er einen Punkt in der Mitte hat):
```Python hl_lines="3"
{!../../docs_src/configure_swagger_ui/tutorial002.py!}
```
{* ../../docs_src/configure_swagger_ui/tutorial002.py hl[3] *}
Obige Konfiguration würde das Theme für die Farbe der Syntaxhervorhebung ändern:
@@ -44,17 +40,13 @@ FastAPI enthält einige Defaultkonfigurationsparameter, die für die meisten Anw
Es umfasst die folgenden Defaultkonfigurationen:
```Python
{!../../fastapi/openapi/docs.py[ln:7-23]!}
```
{* ../../fastapi/openapi/docs.py ln[7:23] *}
Sie können jede davon überschreiben, indem Sie im Argument `swagger_ui_parameters` einen anderen Wert festlegen.
Um beispielsweise `deepLinking` zu deaktivieren, könnten Sie folgende Einstellungen an `swagger_ui_parameters` übergeben:
```Python hl_lines="3"
{!../../docs_src/configure_swagger_ui/tutorial003.py!}
```
{* ../../docs_src/configure_swagger_ui/tutorial003.py hl[3] *}
## Andere Parameter der Swagger-Oberfläche

View File

@@ -40,7 +40,7 @@ Und genau so für ReDoc ...
{!../../docs_src/custom_docs_ui/tutorial001.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Die *Pfadoperation* für `swagger_ui_redirect` ist ein Hilfsmittel bei der Verwendung von OAuth2.
@@ -180,7 +180,7 @@ Und genau so für ReDoc ...
{!../../docs_src/custom_docs_ui/tutorial002.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Die *Pfadoperation* für `swagger_ui_redirect` ist ein Hilfsmittel bei der Verwendung von OAuth2.

View File

@@ -6,7 +6,7 @@ Das kann insbesondere eine gute Alternative zur Logik in einer Middleware sein.
Wenn Sie beispielsweise den Requestbody lesen oder manipulieren möchten, bevor er von Ihrer Anwendung verarbeitet wird.
/// danger | "Gefahr"
/// danger | Gefahr
Dies ist eine „fortgeschrittene“ Funktion.
@@ -30,7 +30,7 @@ Und eine `APIRoute`-Unterklasse zur Verwendung dieser benutzerdefinierten Reques
### Eine benutzerdefinierte `GzipRequest`-Klasse erstellen
/// tip | "Tipp"
/// tip | Tipp
Dies ist nur ein einfaches Beispiel, um zu demonstrieren, wie es funktioniert. Wenn Sie Gzip-Unterstützung benötigen, können Sie die bereitgestellte [`GzipMiddleware`](../advanced/middleware.md#gzipmiddleware){.internal-link target=_blank} verwenden.
@@ -60,7 +60,7 @@ Hier verwenden wir sie, um aus dem ursprünglichen Request einen `GzipRequest` z
{!../../docs_src/custom_request_and_route/tutorial001.py!}
```
/// note | "Technische Details"
/// note | Technische Details
Ein `Request` hat ein `request.scope`-Attribut, welches einfach ein Python-`dict` ist, welches die mit dem Request verbundenen Metadaten enthält.
@@ -84,7 +84,7 @@ Aufgrund unserer Änderungen in `GzipRequest.body` wird der Requestbody jedoch b
## Zugriff auf den Requestbody in einem Exceptionhandler
/// tip | "Tipp"
/// tip | Tipp
Um dasselbe Problem zu lösen, ist es wahrscheinlich viel einfacher, den `body` in einem benutzerdefinierten Handler für `RequestValidationError` zu verwenden ([Fehlerbehandlung](../tutorial/handling-errors.md#den-requestvalidationerror-body-verwenden){.internal-link target=_blank}).

View File

@@ -4,7 +4,7 @@ Da **FastAPI** auf dem **ASGI**-Standard basiert, ist es sehr einfach, jede **Gr
Sie können normale FastAPI-*Pfadoperationen* mit GraphQL in derselben Anwendung kombinieren.
/// tip | "Tipp"
/// tip | Tipp
**GraphQL** löst einige sehr spezifische Anwendungsfälle.
@@ -49,7 +49,7 @@ Frühere Versionen von Starlette enthielten eine `GraphQLApp`-Klasse zur Integra
Das wurde von Starlette deprecated, aber wenn Sie Code haben, der das verwendet, können Sie einfach zu <a href="https://github.com/ciscorn/starlette-graphene3" class="external-link" target="_blank">starlette-graphene3</a> **migrieren**, welches denselben Anwendungsfall abdeckt und über eine **fast identische Schnittstelle** verfügt.
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie GraphQL benötigen, würde ich Ihnen trotzdem empfehlen, sich <a href="https://strawberry.rocks/" class="external-link" target="_blank">Strawberry</a> anzuschauen, da es auf Typannotationen basiert, statt auf benutzerdefinierten Klassen und Typen.

View File

@@ -6,7 +6,7 @@ Die meisten dieser Ideen sind mehr oder weniger **unabhängig**, und in den meis
Wenn etwas für Ihr Projekt interessant und nützlich erscheint, lesen Sie es, andernfalls überspringen Sie es einfach.
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie strukturiert **FastAPI lernen** möchten (empfohlen), lesen Sie stattdessen Kapitel für Kapitel das [Tutorial Benutzerhandbuch](../tutorial/index.md){.internal-link target=_blank}.

View File

@@ -12,7 +12,7 @@ Dies ist lediglich eine **schnelle Anleitung / Auffrischung** über Pythons Typh
Aber selbst wenn Sie **FastAPI** nie verwenden, wird es für Sie nützlich sein, ein wenig darüber zu lernen.
/// note | "Hinweis"
/// note | Hinweis
Wenn Sie ein Python-Experte sind und bereits alles über Typhinweise wissen, überspringen Sie dieses Kapitel und fahren Sie mit dem nächsten fort.
@@ -22,9 +22,7 @@ Wenn Sie ein Python-Experte sind und bereits alles über Typhinweise wissen, üb
Fangen wir mit einem einfachen Beispiel an:
```Python
{!../../docs_src/python_types/tutorial001.py!}
```
{* ../../docs_src/python_types/tutorial001.py *}
Dieses Programm gibt aus:
@@ -38,9 +36,7 @@ Die Funktion macht Folgendes:
* Schreibt den ersten Buchstaben eines jeden Wortes groß, mithilfe von `title()`.
* <abbr title="Füge zu einer Einheit zusammen, eins nach dem anderen.">Verkettet</abbr> sie mit einem Leerzeichen in der Mitte.
```Python hl_lines="2"
{!../../docs_src/python_types/tutorial001.py!}
```
{* ../../docs_src/python_types/tutorial001.py hl[2] *}
### Bearbeiten Sie es
@@ -82,9 +78,7 @@ Das war's.
Das sind die „Typhinweise“:
```Python hl_lines="1"
{!../../docs_src/python_types/tutorial002.py!}
```
{* ../../docs_src/python_types/tutorial002.py hl[1] *}
Das ist nicht das gleiche wie das Deklarieren von Defaultwerten, wie es hier der Fall ist:
@@ -112,9 +106,7 @@ Hier können Sie durch die Optionen blättern, bis Sie diejenige finden, bei der
Sehen Sie sich diese Funktion an, sie hat bereits Typhinweise:
```Python hl_lines="1"
{!../../docs_src/python_types/tutorial003.py!}
```
{* ../../docs_src/python_types/tutorial003.py hl[1] *}
Da der Editor die Typen der Variablen kennt, erhalten Sie nicht nur Code-Vervollständigung, sondern auch eine Fehlerprüfung:
@@ -122,9 +114,7 @@ Da der Editor die Typen der Variablen kennt, erhalten Sie nicht nur Code-Vervoll
Jetzt, da Sie wissen, dass Sie das reparieren müssen, konvertieren Sie `age` mittels `str(age)` in einen String:
```Python hl_lines="2"
{!../../docs_src/python_types/tutorial004.py!}
```
{* ../../docs_src/python_types/tutorial004.py hl[2] *}
## Deklarieren von Typen
@@ -143,9 +133,7 @@ Zum Beispiel diese:
* `bool`
* `bytes`
```Python hl_lines="1"
{!../../docs_src/python_types/tutorial005.py!}
```
{* ../../docs_src/python_types/tutorial005.py hl[1] *}
### Generische Typen mit Typ-Parametern
@@ -207,7 +195,7 @@ Da die Liste ein Typ ist, welcher innere Typen enthält, werden diese von eckige
////
/// tip | "Tipp"
/// tip | Tipp
Die inneren Typen in den eckigen Klammern werden als „Typ-Parameter“ bezeichnet.
@@ -217,7 +205,7 @@ In diesem Fall ist `str` der Typ-Parameter, der an `List` übergeben wird (oder
Das bedeutet: Die Variable `items` ist eine Liste `list` und jedes der Elemente in dieser Liste ist ein String `str`.
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie Python 3.9 oder höher verwenden, müssen Sie `List` nicht von `typing` importieren, Sie können stattdessen den regulären `list`-Typ verwenden.
@@ -320,9 +308,7 @@ Sie können deklarieren, dass ein Wert ein `str`, aber vielleicht auch `None` se
In Python 3.6 und darüber (inklusive Python 3.10) können Sie das deklarieren, indem Sie `Optional` vom `typing` Modul importieren und verwenden.
```Python hl_lines="1 4"
{!../../docs_src/python_types/tutorial009.py!}
```
{* ../../docs_src/python_types/tutorial009.py hl[1,4] *}
Wenn Sie `Optional[str]` anstelle von nur `str` verwenden, wird Ihr Editor Ihnen dabei helfen, Fehler zu erkennen, bei denen Sie annehmen könnten, dass ein Wert immer eine String (`str`) ist, obwohl er auch `None` sein könnte.
@@ -369,9 +355,7 @@ Es geht nur um Wörter und Namen. Aber diese Worte können beeinflussen, wie Sie
Nehmen wir zum Beispiel diese Funktion:
```Python hl_lines="1 4"
{!../../docs_src/python_types/tutorial009c.py!}
```
{* ../../docs_src/python_types/tutorial009c.py hl[1,4] *}
Der Parameter `name` ist definiert als `Optional[str]`, aber er ist **nicht optional**, Sie können die Funktion nicht ohne diesen Parameter aufrufen:
@@ -387,9 +371,7 @@ say_hi(name=None) # Das funktioniert, None is gültig 🎉
Die gute Nachricht ist, dass Sie sich darüber keine Sorgen mehr machen müssen, wenn Sie Python 3.10 verwenden, da Sie einfach `|` verwenden können, um Vereinigungen von Typen zu definieren:
```Python hl_lines="1 4"
{!../../docs_src/python_types/tutorial009c_py310.py!}
```
{* ../../docs_src/python_types/tutorial009c_py310.py hl[1,4] *}
Und dann müssen Sie sich nicht mehr um Namen wie `Optional` und `Union` kümmern. 😎
@@ -451,15 +433,11 @@ Sie können auch eine Klasse als Typ einer Variablen deklarieren.
Nehmen wir an, Sie haben eine Klasse `Person`, mit einem Namen:
```Python hl_lines="1-3"
{!../../docs_src/python_types/tutorial010.py!}
```
{* ../../docs_src/python_types/tutorial010.py hl[1:3] *}
Dann können Sie eine Variable vom Typ `Person` deklarieren:
```Python hl_lines="6"
{!../../docs_src/python_types/tutorial010.py!}
```
{* ../../docs_src/python_types/tutorial010.py hl[6] *}
Und wiederum bekommen Sie die volle Editor-Unterstützung:
@@ -517,7 +495,7 @@ Um mehr über <a href="https://pydantic-docs.helpmanual.io/" class="external-lin
Viel mehr von all dem werden Sie in praktischer Anwendung im [Tutorial - Benutzerhandbuch](tutorial/index.md){.internal-link target=_blank} sehen.
/// tip | "Tipp"
/// tip | Tipp
Pydantic verhält sich speziell, wenn Sie `Optional` oder `Union[Etwas, None]` ohne einen Default-Wert verwenden. Sie können darüber in der Pydantic Dokumentation unter <a href="https://docs.pydantic.dev/2.3/usage/models/#required-fields" class="external-link" target="_blank">Required fields</a> mehr erfahren.
@@ -559,7 +537,7 @@ Im Moment müssen Sie nur wissen, dass `Annotated` existiert, und dass es Standa
Später werden Sie sehen, wie **mächtig** es sein kann.
/// tip | "Tipp"
/// tip | Tipp
Der Umstand, dass es **Standard-Python** ist, bedeutet, dass Sie immer noch die **bestmögliche Entwickler-Erfahrung** in ihrem Editor haben, sowie mit den Tools, die Sie nutzen, um ihren Code zu analysieren, zu refaktorisieren, usw. ✨

View File

@@ -83,7 +83,7 @@ Die Verwendung von `BackgroundTasks` funktioniert auch mit dem <abbr title="Einb
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -97,7 +97,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -133,8 +133,6 @@ Wenn Sie umfangreiche Hintergrundberechnungen durchführen müssen und diese nic
Sie erfordern in der Regel komplexere Konfigurationen und einen Nachrichten-/Job-Queue-Manager wie RabbitMQ oder Redis, ermöglichen Ihnen jedoch die Ausführung von Hintergrundtasks in mehreren Prozessen und insbesondere auf mehreren Servern.
Um ein Beispiel zu sehen, sehen Sie sich die [Projektgeneratoren](../project-generation.md){.internal-link target=_blank} an. Sie alle enthalten Celery, bereits konfiguriert.
Wenn Sie jedoch über dieselbe **FastAPI**-Anwendung auf Variablen und Objekte zugreifen oder kleine Hintergrundtasks ausführen müssen (z. B. das Senden einer E-Mail-Benachrichtigung), können Sie einfach `BackgroundTasks` verwenden.
## Zusammenfassung

View File

@@ -29,7 +29,7 @@ Nehmen wir an, Sie haben eine Dateistruktur wie diese:
│   └── admin.py
```
/// tip | "Tipp"
/// tip | Tipp
Es gibt mehrere `__init__.py`-Dateien: eine in jedem Verzeichnis oder Unterverzeichnis.
@@ -105,7 +105,7 @@ Alle die gleichen Optionen werden unterstützt.
Alle die gleichen `parameters`, `responses`, `dependencies`, `tags`, usw.
/// tip | "Tipp"
/// tip | Tipp
In diesem Beispiel heißt die Variable `router`, aber Sie können ihr einen beliebigen Namen geben.
@@ -139,7 +139,7 @@ Wir werden nun eine einfache Abhängigkeit verwenden, um einen benutzerdefiniert
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -151,7 +151,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// tip | "Tipp"
/// tip | Tipp
Um dieses Beispiel zu vereinfachen, verwenden wir einen erfundenen Header.
@@ -201,7 +201,7 @@ Wir können auch eine Liste von `tags` und zusätzliche `responses` hinzufügen,
Und wir können eine Liste von `dependencies` hinzufügen, die allen *Pfadoperationen* im Router hinzugefügt und für jeden an sie gerichteten Request ausgeführt/aufgelöst werden.
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass ähnlich wie bei [Abhängigkeiten in *Pfadoperation-Dekoratoren*](dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank} kein Wert an Ihre *Pfadoperation-Funktion* übergeben wird.
@@ -222,7 +222,7 @@ Das Endergebnis ist, dass die Pfade für diese Artikel jetzt wie folgt lauten:
* Zuerst werden die Router-Abhängigkeiten ausgeführt, dann die [`dependencies` im Dekorator](dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank} und dann die normalen Parameterabhängigkeiten.
* Sie können auch [`Security`-Abhängigkeiten mit `scopes`](../advanced/security/oauth2-scopes.md){.internal-link target=_blank} hinzufügen.
/// tip | "Tipp"
/// tip | Tipp
`dependencies` im `APIRouter` können beispielsweise verwendet werden, um eine Authentifizierung für eine ganze Gruppe von *Pfadoperationen* zu erfordern. Selbst wenn die Abhängigkeiten nicht jeder einzeln hinzugefügt werden.
@@ -248,7 +248,7 @@ Daher verwenden wir einen relativen Import mit `..` für die Abhängigkeiten:
#### Wie relative Importe funktionieren
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie genau wissen, wie Importe funktionieren, fahren Sie mit dem nächsten Abschnitt unten fort.
@@ -319,7 +319,7 @@ Aber wir können immer noch _mehr_ `tags` hinzufügen, die auf eine bestimmte *P
{!../../docs_src/bigger_applications/app/routers/items.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Diese letzte Pfadoperation wird eine Kombination von Tags haben: `["items", "custom"]`.
@@ -441,7 +441,7 @@ Mit `app.include_router()` können wir jeden `APIRouter` zur Hauptanwendung `Fas
Es wird alle Routen von diesem Router als Teil von dieser inkludieren.
/// note | "Technische Details"
/// note | Technische Details
Tatsächlich wird intern eine *Pfadoperation* für jede *Pfadoperation* erstellt, die im `APIRouter` deklariert wurde.
@@ -504,7 +504,7 @@ Hier machen wir es ... nur um zu zeigen, dass wir es können 🤷:
und es wird korrekt funktionieren, zusammen mit allen anderen *Pfadoperationen*, die mit `app.include_router()` hinzugefügt wurden.
/// info | "Sehr technische Details"
/// info | Sehr technische Details
**Hinweis**: Dies ist ein sehr technisches Detail, das Sie wahrscheinlich **einfach überspringen** können.

View File

@@ -32,7 +32,7 @@ Importieren Sie es zuerst:
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -46,7 +46,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -58,7 +58,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// warning | "Achtung"
/// warning | Achtung
Beachten Sie, dass `Field` direkt von `pydantic` importiert wird, nicht von `fastapi`, wie die anderen (`Query`, `Path`, `Body`, usw.)
@@ -94,7 +94,7 @@ Dann können Sie `Field` mit Modellattributen deklarieren:
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -108,7 +108,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -122,7 +122,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
`Field` funktioniert genauso wie `Query`, `Path` und `Body`, es hat die gleichen Parameter, usw.
/// note | "Technische Details"
/// note | Technische Details
Tatsächlich erstellen `Query`, `Path` und andere, die sie kennenlernen werden, Instanzen von Unterklassen einer allgemeinen Klasse `Param`, die ihrerseits eine Unterklasse von Pydantics `FieldInfo`-Klasse ist.
@@ -134,7 +134,7 @@ Denken Sie daran, dass `Query`, `Path` und andere von `fastapi` tatsächlich Fun
///
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass jedes Modellattribut mit einem Typ, Defaultwert und `Field` die gleiche Struktur hat wie ein Parameter einer Pfadoperation-Funktion, nur mit `Field` statt `Path`, `Query`, `Body`.
@@ -146,7 +146,7 @@ Sie können zusätzliche Information in `Field`, `Query`, `Body`, usw. deklarier
Sie werden später mehr darüber lernen, wie man zusätzliche Information unterbringt, wenn Sie lernen, Beispiele zu deklarieren.
/// warning | "Achtung"
/// warning | Achtung
Extra-Schlüssel, die `Field` überreicht werden, werden auch im resultierenden OpenAPI-Schema Ihrer Anwendung gelistet. Da diese Schlüssel nicht notwendigerweise Teil der OpenAPI-Spezifikation sind, könnten einige OpenAPI-Tools, wie etwa [der OpenAPI-Validator](https://validator.swagger.io/), nicht mit Ihrem generierten Schema funktionieren.

View File

@@ -8,59 +8,9 @@ Zuerst einmal, Sie können `Path`-, `Query`- und Requestbody-Parameter-Deklarati
Und Sie können auch Body-Parameter als optional kennzeichnen, indem Sie den Defaultwert auf `None` setzen:
//// tab | Python 3.10+
{* ../../docs_src/body_multiple_params/tutorial001_an_py310.py hl[18:20] *}
```Python hl_lines="18-20"
{!> ../../docs_src/body_multiple_params/tutorial001_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="18-20"
{!> ../../docs_src/body_multiple_params/tutorial001_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="19-21"
{!> ../../docs_src/body_multiple_params/tutorial001_an.py!}
```
////
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="17-19"
{!> ../../docs_src/body_multiple_params/tutorial001_py310.py!}
```
////
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="19-21"
{!> ../../docs_src/body_multiple_params/tutorial001.py!}
```
////
/// note | "Hinweis"
/// note | Hinweis
Beachten Sie, dass in diesem Fall das `item`, welches vom Body genommen wird, optional ist. Da es `None` als Defaultwert hat.
@@ -81,21 +31,7 @@ Im vorherigen Beispiel erwartete die *Pfadoperation* einen JSON-Body mit den Att
Aber Sie können auch mehrere Body-Parameter deklarieren, z. B. `item` und `user`:
//// tab | Python 3.10+
```Python hl_lines="20"
{!> ../../docs_src/body_multiple_params/tutorial002_py310.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="22"
{!> ../../docs_src/body_multiple_params/tutorial002.py!}
```
////
{* ../../docs_src/body_multiple_params/tutorial002_py310.py hl[20] *}
In diesem Fall wird **FastAPI** bemerken, dass es mehr als einen Body-Parameter in der Funktion gibt (zwei Parameter, die Pydantic-Modelle sind).
@@ -116,7 +52,7 @@ Es wird deshalb die Parameternamen als Schlüssel (Feldnamen) im Body verwenden,
}
```
/// note | "Hinweis"
/// note | Hinweis
Beachten Sie, dass, obwohl `item` wie zuvor deklariert wurde, es nun unter einem Schlüssel `item` im Body erwartet wird.
@@ -136,57 +72,7 @@ Wenn Sie diesen Parameter einfach so hinzufügen, wird **FastAPI** annehmen, das
Aber Sie können **FastAPI** instruieren, ihn als weiteren Body-Schlüssel zu erkennen, indem Sie `Body` verwenden:
//// tab | Python 3.10+
```Python hl_lines="23"
{!> ../../docs_src/body_multiple_params/tutorial003_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="23"
{!> ../../docs_src/body_multiple_params/tutorial003_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="24"
{!> ../../docs_src/body_multiple_params/tutorial003_an.py!}
```
////
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="20"
{!> ../../docs_src/body_multiple_params/tutorial003_py310.py!}
```
////
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="22"
{!> ../../docs_src/body_multiple_params/tutorial003.py!}
```
////
{* ../../docs_src/body_multiple_params/tutorial003_an_py310.py hl[23] *}
In diesem Fall erwartet **FastAPI** einen Body wie:
@@ -226,57 +112,7 @@ q: str | None = None
Zum Beispiel:
//// tab | Python 3.10+
```Python hl_lines="27"
{!> ../../docs_src/body_multiple_params/tutorial004_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="27"
{!> ../../docs_src/body_multiple_params/tutorial004_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="28"
{!> ../../docs_src/body_multiple_params/tutorial004_an.py!}
```
////
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="25"
{!> ../../docs_src/body_multiple_params/tutorial004_py310.py!}
```
////
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="27"
{!> ../../docs_src/body_multiple_params/tutorial004.py!}
```
////
{* ../../docs_src/body_multiple_params/tutorial004_an_py310.py hl[27] *}
/// info
@@ -298,57 +134,7 @@ item: Item = Body(embed=True)
so wie in:
//// tab | Python 3.10+
```Python hl_lines="17"
{!> ../../docs_src/body_multiple_params/tutorial005_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="17"
{!> ../../docs_src/body_multiple_params/tutorial005_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="18"
{!> ../../docs_src/body_multiple_params/tutorial005_an.py!}
```
////
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="15"
{!> ../../docs_src/body_multiple_params/tutorial005_py310.py!}
```
////
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="17"
{!> ../../docs_src/body_multiple_params/tutorial005.py!}
```
////
{* ../../docs_src/body_multiple_params/tutorial005_an_py310.py hl[17] *}
In diesem Fall erwartet **FastAPI** einen Body wie:

View File

@@ -420,7 +420,7 @@ Im folgenden Beispiel akzeptieren Sie irgendein `dict`, solange es `int`-Schlüs
////
/// tip | "Tipp"
/// tip | Tipp
Bedenken Sie, dass JSON nur `str` als Schlüssel unterstützt.

View File

@@ -54,7 +54,7 @@ Sie können auch die <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/
Das bedeutet, sie senden nur die Daten, die Sie aktualisieren wollen, der Rest bleibt unverändert.
/// note | "Hinweis"
/// note | Hinweis
`PATCH` wird seltener verwendet und ist weniger bekannt als `PUT`.
@@ -185,7 +185,7 @@ Zusammengefasst, um Teil-Ersetzungen vorzunehmen:
////
/// tip | "Tipp"
/// tip | Tipp
Sie können tatsächlich die gleiche Technik mit einer HTTP `PUT` Operation verwenden.
@@ -193,7 +193,7 @@ Aber dieses Beispiel verwendet `PATCH`, da dieses für solche Anwendungsfälle g
///
/// note | "Hinweis"
/// note | Hinweis
Beachten Sie, dass das hereinkommende Modell immer noch validiert wird.

View File

@@ -149,7 +149,7 @@ Aber Sie bekommen die gleiche Editor-Unterstützung in <a href="https://www.jetb
<img src="/img/tutorial/body/image05.png">
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie <a href="https://www.jetbrains.com/pycharm/" class="external-link" target="_blank">PyCharm</a> als Ihren Editor verwenden, probieren Sie das <a href="https://github.com/koxudaxi/pydantic-pycharm-plugin/" class="external-link" target="_blank">Pydantic PyCharm Plugin</a> aus.
@@ -233,7 +233,7 @@ Die Funktionsparameter werden wie folgt erkannt:
* Wenn der Parameter ein **einfacher Typ** ist (wie `int`, `float`, `str`, `bool`, usw.), wird er als **Query**-Parameter interpretiert.
* Wenn der Parameter vom Typ eines **Pydantic-Modells** ist, wird er als Request**body** interpretiert.
/// note | "Hinweis"
/// note | Hinweis
FastAPI weiß, dass der Wert von `q` nicht erforderlich ist, wegen des definierten Defaultwertes `= None`

View File

@@ -32,7 +32,7 @@ Importieren Sie zuerst `Cookie`:
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -46,7 +46,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -90,7 +90,7 @@ Der erste Wert ist der Typ. Sie können `Cookie` die gehabten Extra Validierungs
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -104,7 +104,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -116,7 +116,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// note | "Technische Details"
/// note | Technische Details
`Cookie` ist eine Schwesterklasse von `Path` und `Query`. Sie erbt von derselben gemeinsamen `Param`-Elternklasse.

View File

@@ -32,7 +32,7 @@ Im vorherigen Beispiel haben wir ein `dict` von unserer Abhängigkeit („Depend
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -46,7 +46,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -145,7 +145,7 @@ Dann können wir das „Dependable“ `common_parameters` der Abhängigkeit von
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -159,7 +159,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -199,7 +199,7 @@ Achten Sie auf die Methode `__init__`, die zum Erstellen der Instanz der Klasse
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -213,7 +213,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -253,7 +253,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -267,7 +267,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -319,7 +319,7 @@ Jetzt können Sie Ihre Abhängigkeit mithilfe dieser Klasse deklarieren.
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -333,7 +333,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -361,7 +361,7 @@ commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)]
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -397,7 +397,7 @@ commons: Annotated[CommonQueryParams, ...
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -423,7 +423,7 @@ commons: Annotated[Any, Depends(CommonQueryParams)]
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -463,7 +463,7 @@ commons = Depends(CommonQueryParams)
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -477,7 +477,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -507,7 +507,7 @@ commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)]
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -535,7 +535,7 @@ commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)]
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -559,7 +559,7 @@ commons: Annotated[CommonQueryParams, Depends()]
//// tab | Python 3.8 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -601,7 +601,7 @@ Dasselbe Beispiel würde dann so aussehen:
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -615,7 +615,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -629,7 +629,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
... und **FastAPI** wird wissen, was zu tun ist.
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie das eher verwirrt, als Ihnen zu helfen, ignorieren Sie es, Sie *brauchen* es nicht.

View File

@@ -32,7 +32,7 @@ Es sollte eine `list`e von `Depends()` sein:
//// tab | Python 3.8 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -46,7 +46,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
Diese Abhängigkeiten werden auf die gleiche Weise wie normale Abhängigkeiten ausgeführt/aufgelöst. Aber ihr Wert (falls sie einen zurückgeben) wird nicht an Ihre *Pfadoperation-Funktion* übergeben.
/// tip | "Tipp"
/// tip | Tipp
Einige Editoren prüfen, ob Funktionsparameter nicht verwendet werden, und zeigen das als Fehler an.
@@ -90,7 +90,7 @@ Sie können Anforderungen für einen Request (wie Header) oder andere Unterabhä
//// tab | Python 3.8 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -124,7 +124,7 @@ Die Abhängigkeiten können Exceptions `raise`n, genau wie normale Abhängigkeit
//// tab | Python 3.8 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -160,7 +160,7 @@ Sie können also eine normale Abhängigkeit (die einen Wert zurückgibt), die Si
//// tab | Python 3.8 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.

View File

@@ -4,13 +4,13 @@ FastAPI unterstützt Abhängigkeiten, die nach Abschluss einige <abbr title="Man
Verwenden Sie dazu `yield` statt `return` und schreiben Sie die zusätzlichen Schritte / den zusätzlichen Code danach.
/// tip | "Tipp"
/// tip | Tipp
Stellen Sie sicher, dass Sie `yield` nur einmal pro Abhängigkeit verwenden.
///
/// note | "Technische Details"
/// note | Technische Details
Jede Funktion, die dekoriert werden kann mit:
@@ -45,7 +45,7 @@ Der auf die `yield`-Anweisung folgende Code wird ausgeführt, nachdem die Respon
{!../../docs_src/dependencies/tutorial007.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Sie können `async`hrone oder reguläre Funktionen verwenden.
@@ -93,7 +93,7 @@ Beispielsweise kann `dependency_c` von `dependency_b` und `dependency_b` von `de
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -129,7 +129,7 @@ Und wiederum benötigt `dependency_b` den Wert von `dependency_a` (hier `dep_a`
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -149,7 +149,7 @@ Sie können beliebige Kombinationen von Abhängigkeiten haben.
**FastAPI** stellt sicher, dass alles in der richtigen Reihenfolge ausgeführt wird.
/// note | "Technische Details"
/// note | Technische Details
Dieses funktioniert dank Pythons <a href="https://docs.python.org/3/library/contextlib.html" class="external-link" target="_blank">Kontextmanager</a>.
@@ -163,7 +163,7 @@ Sie haben gesehen, dass Ihre Abhängigkeiten `yield` verwenden können und `try`
Auf die gleiche Weise könnten Sie im Exit-Code nach dem `yield` eine `HTTPException` oder ähnliches auslösen.
/// tip | "Tipp"
/// tip | Tipp
Dies ist eine etwas fortgeschrittene Technik, die Sie in den meisten Fällen nicht wirklich benötigen, da Sie Exceptions (einschließlich `HTTPException`) innerhalb des restlichen Anwendungscodes auslösen können, beispielsweise in der *Pfadoperation-Funktion*.
@@ -189,7 +189,7 @@ Aber es ist für Sie da, wenn Sie es brauchen. 🤓
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -250,7 +250,7 @@ Nachdem eine dieser Responses gesendet wurde, kann keine weitere Response gesend
///
/// tip | "Tipp"
/// tip | Tipp
Obiges Diagramm verwendet `HTTPException`, aber Sie können auch jede andere Exception auslösen, die Sie in einer Abhängigkeit mit `yield` abfangen, oder mit einem [benutzerdefinierten Exceptionhandler](../handling-errors.md#benutzerdefinierte-exceptionhandler-definieren){.internal-link target=_blank} erstellt haben.
@@ -260,7 +260,7 @@ Wenn Sie eine Exception auslösen, wird diese mit yield an die Abhängigkeiten
## Abhängigkeiten mit `yield`, `HTTPException` und Hintergrundtasks
/// warning | "Achtung"
/// warning | Achtung
Sie benötigen diese technischen Details höchstwahrscheinlich nicht, Sie können diesen Abschnitt überspringen und weiter unten fortfahren.
@@ -274,7 +274,7 @@ Dies wurde hauptsächlich so konzipiert, damit die gleichen Objekte, die durch A
Da dies jedoch bedeuten würde, darauf zu warten, dass die Response durch das Netzwerk reist, während eine Ressource unnötigerweise in einer Abhängigkeit mit yield gehalten wird (z. B. eine Datenbankverbindung), wurde dies in FastAPI 0.106.0 geändert.
/// tip | "Tipp"
/// tip | Tipp
Darüber hinaus handelt es sich bei einem Hintergrundtask normalerweise um einen unabhängigen Satz von Logik, der separat behandelt werden sollte, mit eigenen Ressourcen (z. B. einer eigenen Datenbankverbindung).
@@ -308,7 +308,7 @@ Wenn Sie eine Abhängigkeit mit `yield` erstellen, erstellt **FastAPI** dafür i
### Kontextmanager in Abhängigkeiten mit `yield` verwenden
/// warning | "Achtung"
/// warning | Achtung
Dies ist mehr oder weniger eine „fortgeschrittene“ Idee.
@@ -324,7 +324,7 @@ Sie können solche auch innerhalb von **FastAPI**-Abhängigkeiten mit `yield` ve
{!../../docs_src/dependencies/tutorial010.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Andere Möglichkeiten, einen Kontextmanager zu erstellen, sind:

View File

@@ -24,7 +24,7 @@ In diesem Fall werden sie auf alle *Pfadoperationen* in der Anwendung angewendet
//// tab | Python 3.8 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.

View File

@@ -56,7 +56,7 @@ Es handelt sich einfach um eine Funktion, die die gleichen Parameter entgegennim
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -70,7 +70,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -138,7 +138,7 @@ Bitte [aktualisieren Sie FastAPI](../../deployment/versions.md#upgrade-der-fasta
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -152,7 +152,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -194,7 +194,7 @@ So wie auch `Body`, `Query`, usw., verwenden Sie `Depends` mit den Parametern Ih
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -208,7 +208,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -230,7 +230,7 @@ Sie **rufen diese nicht direkt auf** (fügen Sie am Ende keine Klammern hinzu),
Und diese Funktion akzeptiert Parameter auf die gleiche Weise wie *Pfadoperation-Funktionen*.
/// tip | "Tipp"
/// tip | Tipp
Im nächsten Kapitel erfahren Sie, welche anderen „Dinge“, außer Funktionen, Sie als Abhängigkeiten verwenden können.
@@ -299,7 +299,7 @@ Da wir jedoch `Annotated` verwenden, können wir diesen `Annotated`-Wert in eine
////
/// tip | "Tipp"
/// tip | Tipp
Das ist schlicht Standard-Python, es wird als „Typalias“ bezeichnet und ist eigentlich nicht **FastAPI**-spezifisch.
@@ -321,7 +321,7 @@ Und Sie können Abhängigkeiten mit `async def` innerhalb normaler `def`-*Pfadop
Es spielt keine Rolle. **FastAPI** weiß, was zu tun ist.
/// note | "Hinweis"
/// note | Hinweis
Wenn Ihnen das nichts sagt, lesen Sie den [Async: *„In Eile?“*](../../async.md#in-eile){.internal-link target=_blank}-Abschnitt über `async` und `await` in der Dokumentation.

View File

@@ -36,7 +36,7 @@ Sie könnten eine erste Abhängigkeit („Dependable“) wie folgt erstellen:
//// tab | Python 3.10 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -50,7 +50,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -96,7 +96,7 @@ Dann können Sie eine weitere Abhängigkeitsfunktion (ein „Dependable“) erst
//// tab | Python 3.10 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -110,7 +110,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -159,7 +159,7 @@ Diese Abhängigkeit verwenden wir nun wie folgt:
//// tab | Python 3.10 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -173,7 +173,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -223,7 +223,7 @@ async def needy_dependency(fresh_value: Annotated[str, Depends(get_value, use_ca
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -244,7 +244,7 @@ Einfach Funktionen, die genauso aussehen wie *Pfadoperation-Funktionen*.
Dennoch ist es sehr mächtig und ermöglicht Ihnen die Deklaration beliebig tief verschachtelter Abhängigkeits-„Graphen“ (Bäume).
/// tip | "Tipp"
/// tip | Tipp
All dies scheint angesichts dieser einfachen Beispiele möglicherweise nicht so nützlich zu sein.

View File

@@ -42,7 +42,7 @@ Das Resultat dieses Aufrufs ist etwas, das mit Pythons Standard-<a href="https:/
Es wird also kein großer `str` zurückgegeben, der die Daten im JSON-Format (als String) enthält. Es wird eine Python-Standarddatenstruktur (z. B. ein `dict`) zurückgegeben, mit Werten und Unterwerten, die alle mit JSON kompatibel sind.
/// note | "Hinweis"
/// note | Hinweis
`jsonable_encoder` wird tatsächlich von **FastAPI** intern verwendet, um Daten zu konvertieren. Aber es ist in vielen anderen Szenarien hilfreich.

View File

@@ -8,7 +8,7 @@ Insbesondere Benutzermodelle, denn:
* Das **herausgehende Modell** sollte kein Passwort haben.
* Das **Datenbankmodell** sollte wahrscheinlich ein <abbr title='Ein aus scheinbar zufälligen Zeichen bestehender „Fingerabdruck“ eines Textes. Der Inhalt des Textes kann nicht eingesehen werden.'>gehashtes</abbr> Passwort haben.
/// danger | "Gefahr"
/// danger | Gefahr
Speichern Sie niemals das Klartext-Passwort eines Benutzers. Speichern Sie immer den „sicheren Hash“, den Sie verifizieren können.
@@ -154,7 +154,7 @@ UserInDB(
)
```
/// warning | "Achtung"
/// warning | Achtung
Die Hilfsfunktionen `fake_password_hasher` und `fake_save_user` demonstrieren nur den möglichen Fluss der Daten und bieten natürlich keine echte Sicherheit.
@@ -200,7 +200,7 @@ Das wird in OpenAPI mit `anyOf` angezeigt.
Um das zu tun, verwenden Sie Pythons Standard-Typhinweis <a href="https://docs.python.org/3/library/typing.html#typing.Union" class="external-link" target="_blank">`typing.Union`</a>:
/// note | "Hinweis"
/// note | Hinweis
Listen Sie, wenn Sie eine <a href="https://pydantic-docs.helpmanual.io/usage/types/#unions" class="external-link" target="_blank">`Union`</a> definieren, denjenigen Typ zuerst, der am spezifischsten ist, gefolgt von den weniger spezifischen Typen. Im Beispiel oben, in `Union[PlaneItem, CarItem]` also den spezifischeren `PlaneItem` vor dem weniger spezifischen `CarItem`.

View File

@@ -24,7 +24,7 @@ $ uvicorn main:app --reload
</div>
/// note | "Hinweis"
/// note | Hinweis
Der Befehl `uvicorn main:app` bezieht sich auf:
@@ -139,7 +139,7 @@ Ebenfalls können Sie es verwenden, um automatisch Code für Clients zu generier
`FastAPI` ist eine Python-Klasse, die die gesamte Funktionalität für Ihre API bereitstellt.
/// note | "Technische Details"
/// note | Technische Details
`FastAPI` ist eine Klasse, die direkt von `Starlette` erbt.
@@ -259,7 +259,7 @@ Das `@app.get("/")` sagt **FastAPI**, dass die Funktion direkt darunter für die
* den Pfad `/`
* unter der Verwendung der <abbr title="eine HTTP GET Methode"><code>get</code>-Operation</abbr> gehen
/// info | "`@decorator` Information"
/// info | `@decorator` Information
Diese `@something`-Syntax wird in Python „Dekorator“ genannt.
@@ -286,7 +286,7 @@ Oder die exotischeren:
* `@app.patch()`
* `@app.trace()`
/// tip | "Tipp"
/// tip | Tipp
Es steht Ihnen frei, jede Operation (HTTP-Methode) so zu verwenden, wie Sie es möchten.
@@ -324,7 +324,7 @@ Sie könnten sie auch als normale Funktion anstelle von `async def` definieren:
{!../../docs_src/first_steps/tutorial003.py!}
```
/// note | "Hinweis"
/// note | Hinweis
Wenn Sie den Unterschied nicht kennen, lesen Sie [Async: *„In Eile?“*](../async.md#in-eile){.internal-link target=_blank}.

View File

@@ -63,7 +63,7 @@ Aber wenn der Client `http://example.com/items/bar` anfragt (ein nicht-existiere
}
```
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie eine `HTTPException` auslösen, können Sie dem Parameter `detail` jeden Wert übergeben, der nach JSON konvertiert werden kann, nicht nur `str`.
@@ -109,7 +109,7 @@ Sie erhalten also einen sauberen Error mit einem Statuscode `418` und dem JSON-I
{"message": "Oops! yolo did something. There goes a rainbow..."}
```
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette.requests import Request` und `from starlette.responses import JSONResponse` verwenden.
@@ -166,7 +166,7 @@ path -> item_id
#### `RequestValidationError` vs. `ValidationError`
/// warning | "Achtung"
/// warning | Achtung
Das folgende sind technische Details, die Sie überspringen können, wenn sie für Sie nicht wichtig sind.
@@ -192,7 +192,7 @@ Zum Beispiel könnten Sie eine Klartext-Response statt JSON für diese Fehler zu
{!../../docs_src/handling_errors/tutorial004.py!}
```
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette.responses import PlainTextResponse` verwenden.

View File

@@ -32,7 +32,7 @@ Importieren Sie zuerst `Header`:
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -46,7 +46,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -90,7 +90,7 @@ Der erste Wert ist der Typ. Sie können `Header` die gehabten Extra Validierungs
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -104,7 +104,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -116,7 +116,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// note | "Technische Details"
/// note | Technische Details
`Header` ist eine Schwesterklasse von `Path`, `Query` und `Cookie`. Sie erbt von derselben gemeinsamen `Param`-Elternklasse.
@@ -172,7 +172,7 @@ Wenn Sie aus irgendeinem Grund das automatische Konvertieren von Unterstrichen z
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -186,7 +186,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -198,7 +198,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// warning | "Achtung"
/// warning | Achtung
Bevor Sie `convert_underscores` auf `False` setzen, bedenken Sie, dass manche HTTP-Proxys und Server die Verwendung von Headern mit Unterstrichen nicht erlauben.
@@ -240,7 +240,7 @@ Um zum Beispiel einen Header `X-Token` zu deklarieren, der mehrmals vorkommen ka
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -254,7 +254,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -268,7 +268,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.

View File

@@ -52,7 +52,7 @@ $ pip install "fastapi[all]"
... das beinhaltet auch `uvicorn`, welchen Sie als Server verwenden können, der ihren Code ausführt.
/// note | "Hinweis"
/// note | Hinweis
Sie können die einzelnen Teile auch separat installieren.

View File

@@ -22,7 +22,7 @@ Sie können diese wie folgt setzen:
{!../../docs_src/metadata/tutorial001.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Sie können Markdown in das Feld `description` schreiben und es wird in der Ausgabe gerendert.
@@ -68,7 +68,7 @@ Erstellen Sie Metadaten für Ihre Tags und übergeben Sie sie an den Parameter `
Beachten Sie, dass Sie Markdown in den Beschreibungen verwenden können. Beispielsweise wird „login“ in Fettschrift (**login**) und „fancy“ in Kursivschrift (_fancy_) angezeigt.
/// tip | "Tipp"
/// tip | Tipp
Sie müssen nicht für alle von Ihnen verwendeten Tags Metadaten hinzufügen.

View File

@@ -11,7 +11,7 @@ Eine „Middleware“ ist eine Funktion, die mit jedem **Request** arbeitet, bev
* Sie kann etwas mit dieser **Response** tun oder beliebigen Code ausführen.
* Dann gibt sie die **Response** zurück.
/// note | "Technische Details"
/// note | Technische Details
Wenn Sie Abhängigkeiten mit `yield` haben, wird der Exit-Code *nach* der Middleware ausgeführt.
@@ -31,11 +31,9 @@ Die Middleware-Funktion erhält:
* Dann gibt es die von der entsprechenden *Pfadoperation* generierte `response` zurück.
* Sie können die `response` dann weiter modifizieren, bevor Sie sie zurückgeben.
```Python hl_lines="8-9 11 14"
{!../../docs_src/middleware/tutorial001.py!}
```
{* ../../docs_src/middleware/tutorial001.py hl[8:9,11,14] *}
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass benutzerdefinierte proprietäre Header hinzugefügt werden können. <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers" class="external-link" target="_blank">Verwenden Sie dafür das Präfix 'X-'</a>.
@@ -43,7 +41,7 @@ Wenn Sie jedoch benutzerdefinierte Header haben, die ein Client in einem Browser
///
/// note | "Technische Details"
/// note | Technische Details
Sie könnten auch `from starlette.requests import Request` verwenden.
@@ -59,9 +57,7 @@ Und auch nachdem die `response` generiert wurde, bevor sie zurückgegeben wird.
Sie könnten beispielsweise einen benutzerdefinierten Header `X-Process-Time` hinzufügen, der die Zeit in Sekunden enthält, die benötigt wurde, um den Request zu verarbeiten und eine Response zu generieren:
```Python hl_lines="10 12-13"
{!../../docs_src/middleware/tutorial001.py!}
```
{* ../../docs_src/middleware/tutorial001.py hl[10,12:13] *}
## Andere Middlewares

View File

@@ -2,7 +2,7 @@
Es gibt mehrere Konfigurations-Parameter, die Sie Ihrem *Pfadoperation-Dekorator* übergeben können.
/// warning | "Achtung"
/// warning | Achtung
Beachten Sie, dass diese Parameter direkt dem *Pfadoperation-Dekorator* übergeben werden, nicht der *Pfadoperation-Funktion*.
@@ -42,7 +42,7 @@ Aber falls Sie sich nicht mehr erinnern, wofür jede Nummer steht, können Sie d
Dieser Statuscode wird in der Response verwendet und zum OpenAPI-Schema hinzugefügt.
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette import status` verwenden.

View File

@@ -32,7 +32,7 @@ Importieren Sie zuerst `Path` von `fastapi`, und importieren Sie `Annotated`.
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -46,7 +46,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -100,7 +100,7 @@ Um zum Beispiel einen `title`-Metadaten-Wert für den Pfad-Parameter `item_id` z
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -114,7 +114,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -126,7 +126,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// note | "Hinweis"
/// note | Hinweis
Ein Pfad-Parameter ist immer erforderlich, weil er Teil des Pfads sein muss.
@@ -138,7 +138,7 @@ Doch selbst wenn Sie ihn mit `None` deklarieren, oder einen Defaultwert setzen,
## Sortieren Sie die Parameter, wie Sie möchten
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie `Annotated` verwenden, ist das folgende nicht so wichtig / nicht notwendig.
@@ -160,7 +160,7 @@ Sie können Ihre Funktion also so deklarieren:
//// tab | Python 3.8 nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -192,7 +192,7 @@ Aber bedenken Sie, dass Sie dieses Problem nicht haben, wenn Sie `Annotated` ver
## Sortieren Sie die Parameter wie Sie möchten: Tricks
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie `Annotated` verwenden, ist das folgende nicht so wichtig / nicht notwendig.
@@ -260,7 +260,7 @@ Hier, mit `ge=1`, wird festgelegt, dass `item_id` eine Ganzzahl benötigt, die g
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -297,7 +297,7 @@ Das Gleiche trifft zu auf:
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -337,7 +337,7 @@ Das gleiche gilt für <abbr title="less than kleiner als"><code>lt</code></a
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -368,7 +368,7 @@ Sie alle teilen die gleichen Parameter für zusätzliche Validierung und Metadat
///
/// note | "Technische Details"
/// note | Technische Details
`Query`, `Path` und andere, die Sie von `fastapi` importieren, sind tatsächlich Funktionen.

View File

@@ -159,7 +159,7 @@ Erstellen Sie dann Klassen-Attribute mit festgelegten Werten, welches die erlaub
///
/// tip | "Tipp"
/// tip | Tipp
Falls Sie sich fragen, was „AlexNet“, „ResNet“ und „LeNet“ ist, das sind Namen von <abbr title="Genau genommen, Deep-Learning-Modellarchitekturen">Modellen</abbr> für maschinelles Lernen.
@@ -199,7 +199,7 @@ Den tatsächlichen Wert (in diesem Fall ein `str`) erhalten Sie via `model_name.
{!../../docs_src/path_params/tutorial005.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Sie können den Wert `"lenet"` außerdem mittels `ModelName.lenet.value` abrufen.
@@ -256,7 +256,7 @@ Sie verwenden das also wie folgt:
{!../../docs_src/path_params/tutorial004.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Der Parameter könnte einen führenden Schrägstrich (`/`) haben, wie etwa in `/home/johndoe/myfile.txt`.

View File

@@ -22,7 +22,7 @@ Nehmen wir als Beispiel die folgende Anwendung:
Der Query-Parameter `q` hat den Typ `Union[str, None]` (oder `str | None` in Python 3.10), was bedeutet, er ist entweder ein `str` oder `None`. Der Defaultwert ist `None`, also weiß FastAPI, der Parameter ist nicht erforderlich.
/// note | "Hinweis"
/// note | Hinweis
FastAPI weiß nur dank des definierten Defaultwertes `=None`, dass der Wert von `q` nicht erforderlich ist
@@ -153,7 +153,7 @@ FastAPI wird nun:
Frühere Versionen von FastAPI (vor <abbr title="vor 2023-03">0.95.0</abbr>) benötigten `Query` als Defaultwert des Parameters, statt es innerhalb von `Annotated` unterzubringen. Die Chance ist groß, dass Sie Quellcode sehen, der das immer noch so macht, darum erkläre ich es Ihnen.
/// tip | "Tipp"
/// tip | Tipp
Verwenden Sie für neuen Code, und wann immer möglich, `Annotated`, wie oben erklärt. Es gibt mehrere Vorteile (unten erläutert) und keine Nachteile. 🍰
@@ -301,7 +301,7 @@ Sie können auch einen Parameter `min_length` hinzufügen:
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -315,7 +315,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -357,7 +357,7 @@ Sie können einen <abbr title="Ein regulärer Ausdruck, auch regex oder regexp g
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -371,7 +371,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -433,7 +433,7 @@ Beispielsweise könnten Sie den `q` Query-Parameter so deklarieren, dass er eine
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -445,7 +445,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// note | "Hinweis"
/// note | Hinweis
Ein Parameter ist optional (nicht erforderlich), wenn er irgendeinen Defaultwert, auch `None`, hat.
@@ -503,7 +503,7 @@ Wenn Sie einen Parameter erforderlich machen wollen, während Sie `Query` verwen
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -513,7 +513,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
{!> ../../docs_src/query_params_str_validations/tutorial006.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass, obwohl in diesem Fall `Query()` der Funktionsparameter-Defaultwert ist, wir nicht `default=None` zu `Query()` hinzufügen.
@@ -545,7 +545,7 @@ Es gibt eine Alternative, die explizit deklariert, dass ein Wert erforderlich is
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -599,7 +599,7 @@ Um das zu machen, deklarieren Sie, dass `None` ein gültiger Typ ist, aber verwe
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -613,7 +613,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -625,13 +625,13 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// tip | "Tipp"
/// tip | Tipp
Pydantic, welches die gesamte Datenvalidierung und Serialisierung in FastAPI antreibt, hat ein spezielles Verhalten, wenn Sie `Optional` oder `Union[Something, None]` ohne Defaultwert verwenden, Sie können mehr darüber in der Pydantic-Dokumentation unter <a href="https://docs.pydantic.dev/2.3/usage/models/#required-fields" class="external-link" target="_blank">Required fields</a> erfahren.
///
/// tip | "Tipp"
/// tip | Tipp
Denken Sie daran, dass Sie in den meisten Fällen, wenn etwas erforderlich ist, einfach den Defaultwert weglassen können. Sie müssen also normalerweise `...` nicht verwenden.
@@ -669,7 +669,7 @@ Um zum Beispiel einen Query-Parameter `q` zu deklarieren, der mehrere Male in de
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -683,7 +683,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -697,7 +697,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -728,7 +728,7 @@ Die Response für diese URL wäre also:
}
```
/// tip | "Tipp"
/// tip | Tipp
Um einen Query-Parameter vom Typ `list` zu deklarieren, wie im Beispiel oben, müssen Sie explizit `Query` verwenden, sonst würde der Parameter als Requestbody interpretiert werden.
@@ -760,7 +760,7 @@ Und Sie können auch eine Default-`list`e von Werten definieren, wenn keine übe
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -774,7 +774,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -825,7 +825,7 @@ Sie können auch `list` direkt verwenden, anstelle von `List[str]` (oder `list[s
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -837,7 +837,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// note | "Hinweis"
/// note | Hinweis
Beachten Sie, dass FastAPI in diesem Fall den Inhalt der Liste nicht überprüft.
@@ -851,7 +851,7 @@ Sie können mehr Informationen zum Parameter hinzufügen.
Diese Informationen werden zur generierten OpenAPI hinzugefügt, und von den Dokumentations-Oberflächen und von externen Tools verwendet.
/// note | "Hinweis"
/// note | Hinweis
Beachten Sie, dass verschiedene Tools OpenAPI möglicherweise unterschiedlich gut unterstützen.
@@ -887,7 +887,7 @@ Sie können einen Titel hinzufügen `title`:
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -901,7 +901,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -941,7 +941,7 @@ Und eine Beschreibung `description`:
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -955,7 +955,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -1011,7 +1011,7 @@ Dann können Sie einen `alias` deklarieren, und dieser Alias wird verwendet, um
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -1025,7 +1025,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -1071,7 +1071,7 @@ In diesem Fall fügen Sie den Parameter `deprecated=True` zu `Query` hinzu.
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -1085,7 +1085,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -1131,7 +1131,7 @@ Um einen Query-Parameter vom generierten OpenAPI-Schema auszuschließen (und dah
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -1145,7 +1145,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.

View File

@@ -241,7 +241,7 @@ In diesem Fall gibt es drei Query-Parameter:
* `skip`, ein `int` mit einem Defaultwert `0`.
* `limit`, ein optionales `int`.
/// tip | "Tipp"
/// tip | Tipp
Sie können auch `Enum`s verwenden, auf die gleiche Weise wie mit [Pfad-Parametern](path-params.md#vordefinierte-parameterwerte){.internal-link target=_blank}.

View File

@@ -34,7 +34,7 @@ Importieren Sie `File` und `UploadFile` von `fastapi`:
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -68,7 +68,7 @@ Erstellen Sie Datei-Parameter, so wie Sie es auch mit `Body` und `Form` machen w
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -88,7 +88,7 @@ Aber erinnern Sie sich, dass, wenn Sie `Query`, `Path`, `File` und andere von `
///
/// tip | "Tipp"
/// tip | Tipp
Um Dateibodys zu deklarieren, müssen Sie `File` verwenden, da diese Parameter sonst als Query-Parameter oder Body(-JSON)-Parameter interpretiert werden würden.
@@ -124,7 +124,7 @@ Definieren Sie einen Datei-Parameter mit dem Typ `UploadFile`:
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -177,13 +177,13 @@ Wenn Sie sich innerhalb einer normalen `def`-*Pfadoperation-Funktion* befinden,
contents = myfile.file.read()
```
/// note | "Technische Details zu `async`"
/// note | Technische Details zu `async`
Wenn Sie die `async`-Methoden verwenden, führt **FastAPI** die Datei-Methoden in einem <abbr title="Mehrere unabhängige Kindprozesse">Threadpool</abbr> aus und erwartet sie.
///
/// note | "Technische Details zu Starlette"
/// note | Technische Details zu Starlette
**FastAPI**s `UploadFile` erbt direkt von **Starlette**s `UploadFile`, fügt aber ein paar notwendige Teile hinzu, um es kompatibel mit **Pydantic** und anderen Teilen von FastAPI zu machen.
@@ -195,7 +195,7 @@ HTML-Formulare (`<form></form>`) senden die Daten in einer „speziellen“ Kodi
**FastAPI** stellt sicher, dass diese Daten korrekt ausgelesen werden, statt JSON zu erwarten.
/// note | "Technische Details"
/// note | Technische Details
Daten aus Formularen werden, wenn es keine Dateien sind, normalerweise mit dem <abbr title='Media type Medientyp, Typ des Mediums'>„media type“</abbr> `application/x-www-form-urlencoded` kodiert.
@@ -205,7 +205,7 @@ Wenn Sie mehr über Formularfelder und ihre Kodierungen lesen möchten, besuchen
///
/// warning | "Achtung"
/// warning | Achtung
Sie können mehrere `File`- und `Form`-Parameter in einer *Pfadoperation* deklarieren, aber Sie können nicht gleichzeitig auch `Body`-Felder deklarieren, welche Sie als JSON erwarten, da der Request den Body mittels `multipart/form-data` statt `application/json` kodiert.
@@ -243,7 +243,7 @@ Sie können eine Datei optional machen, indem Sie Standard-Typannotationen verwe
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -257,7 +257,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -291,7 +291,7 @@ Sie können auch `File()` zusammen mit `UploadFile` verwenden, um zum Beispiel z
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -329,7 +329,7 @@ Um das zu machen, deklarieren Sie eine Liste von `bytes` oder `UploadFile`s:
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -343,7 +343,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -357,7 +357,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
Sie erhalten, wie deklariert, eine `list`e von `bytes` oder `UploadFile`s.
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette.responses import HTMLResponse` verwenden.
@@ -387,7 +387,7 @@ Und so wie zuvor können Sie `File()` verwenden, um zusätzliche Parameter zu se
//// tab | Python 3.9+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -401,7 +401,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.

View File

@@ -30,7 +30,7 @@ Z. B. `pip install python-multipart`.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -64,7 +64,7 @@ Erstellen Sie Datei- und Formularparameter, so wie Sie es auch mit `Body` und `Q
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -80,7 +80,7 @@ Die Datei- und Formularfelder werden als Formulardaten hochgeladen, und Sie erha
Und Sie können einige der Dateien als `bytes` und einige als `UploadFile` deklarieren.
/// warning | "Achtung"
/// warning | Achtung
Sie können mehrere `File`- und `Form`-Parameter in einer *Pfadoperation* deklarieren, aber Sie können nicht gleichzeitig auch `Body`-Felder deklarieren, welche Sie als JSON erwarten, da der Request den Body mittels `multipart/form-data` statt `application/json` kodiert.

View File

@@ -32,7 +32,7 @@ Importieren Sie `Form` von `fastapi`:
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -66,7 +66,7 @@ Erstellen Sie Formular-Parameter, so wie Sie es auch mit `Body` und `Query` mach
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -90,7 +90,7 @@ Mit `Form` haben Sie die gleichen Konfigurationsmöglichkeiten wie mit `Body` (u
///
/// tip | "Tipp"
/// tip | Tipp
Um Formularbodys zu deklarieren, verwenden Sie explizit `Form`, da diese Parameter sonst als Query-Parameter oder Body(-JSON)-Parameter interpretiert werden würden.
@@ -102,7 +102,7 @@ HTML-Formulare (`<form></form>`) senden die Daten in einer „speziellen“ Kodi
**FastAPI** stellt sicher, dass diese Daten korrekt ausgelesen werden, statt JSON zu erwarten.
/// note | "Technische Details"
/// note | Technische Details
Daten aus Formularen werden normalerweise mit dem <abbr title='Media type Medientyp, Typ des Mediums'>„media type“</abbr> `application/x-www-form-urlencoded` kodiert.
@@ -112,7 +112,7 @@ Wenn Sie mehr über Formularfelder und ihre Kodierungen lesen möchten, besuchen
///
/// warning | "Achtung"
/// warning | Achtung
Sie können mehrere `Form`-Parameter in einer *Pfadoperation* deklarieren, aber Sie können nicht gleichzeitig auch `Body`-Felder deklarieren, welche Sie als JSON erwarten, da der Request den Body mittels `application/x-www-form-urlencoded` statt `application/json` kodiert.

View File

@@ -83,7 +83,7 @@ Sie können `response_model` in jeder möglichen *Pfadoperation* verwenden:
////
/// note | "Hinweis"
/// note | Hinweis
Beachten Sie, dass `response_model` ein Parameter der „Dekorator“-Methode ist (`get`, `post`, usw.). Nicht der *Pfadoperation-Funktion*, so wie die anderen Parameter.
@@ -93,7 +93,7 @@ Beachten Sie, dass `response_model` ein Parameter der „Dekorator“-Methode is
FastAPI wird dieses `response_model` nehmen, um die Daten zu dokumentieren, validieren, usw. und auch, um **die Ausgabedaten** entsprechend der Typdeklaration **zu konvertieren und filtern**.
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie in Ihrem Editor strikte Typchecks haben, mypy, usw., können Sie den Funktions-Rückgabetyp als <abbr title='„Irgend etwas“'>`Any`</abbr> deklarieren.
@@ -162,7 +162,7 @@ Hier ist das möglicherweise kein Problem, da es derselbe Benutzer ist, der das
Aber wenn wir dasselbe Modell für eine andere *Pfadoperation* verwenden, könnten wir das Passwort dieses Benutzers zu jedem Client schicken.
/// danger | "Gefahr"
/// danger | Gefahr
Speichern Sie niemals das Klartext-Passwort eines Benutzers, oder versenden Sie es in einer Response wie dieser, wenn Sie sich nicht der resultierenden Gefahren bewusst sind und nicht wissen, was Sie tun.
@@ -503,7 +503,7 @@ dann ist FastAPI klug genug (tatsächlich ist Pydantic klug genug) zu erkennen,
Diese Felder werden also in der JSON-Response enthalten sein.
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass Defaultwerte alles Mögliche sein können, nicht nur `None`.
@@ -519,7 +519,7 @@ Diese nehmen ein `set` von `str`s entgegen, welches Namen von Attributen sind, d
Das kann als schnelle Abkürzung verwendet werden, wenn Sie nur ein Pydantic-Modell haben und ein paar Daten von der Ausgabe ausschließen wollen.
/// tip | "Tipp"
/// tip | Tipp
Es wird dennoch empfohlen, dass Sie die Ideen von oben verwenden, also mehrere Klassen statt dieser Parameter.
@@ -545,7 +545,7 @@ Das trifft auch auf `response_model_by_alias` zu, welches ähnlich funktioniert.
////
/// tip | "Tipp"
/// tip | Tipp
Die Syntax `{"name", "description"}` erzeugt ein `set` mit diesen zwei Werten.

View File

@@ -8,11 +8,9 @@ So wie ein Responsemodell, können Sie auch einen HTTP-Statuscode für die Respo
* `@app.delete()`
* usw.
```Python hl_lines="6"
{!../../docs_src/response_status_code/tutorial001.py!}
```
{* ../../docs_src/response_status_code/tutorial001.py hl[6] *}
/// note | "Hinweis"
/// note | Hinweis
Beachten Sie, dass `status_code` ein Parameter der „Dekorator“-Methode ist (`get`, `post`, usw.). Nicht der *Pfadoperation-Funktion*, so wie die anderen Parameter und der Body.
@@ -33,7 +31,7 @@ Das wird:
<img src="/img/tutorial/response-status-code/image01.png">
/// note | "Hinweis"
/// note | Hinweis
Einige Responsecodes (siehe nächster Abschnitt) kennzeichnen, dass die Response keinen Body hat.
@@ -43,7 +41,7 @@ FastAPI versteht das und wird in der OpenAPI-Dokumentation anzeigen, dass es kei
## Über HTTP-Statuscodes
/// note | "Hinweis"
/// note | Hinweis
Wenn Sie bereits wissen, was HTTP-Statuscodes sind, überspringen Sie dieses Kapitel und fahren Sie mit dem nächsten fort.
@@ -66,7 +64,7 @@ Kurz:
* Für allgemeine Fehler beim Client können Sie einfach `400` verwenden.
* `500` und darüber stehen für Server-Fehler. Diese verwenden Sie fast nie direkt. Wenn etwas an irgendeiner Stelle in Ihrem Anwendungscode oder im Server schiefläuft, wird automatisch einer dieser Fehler-Statuscodes zurückgegeben.
/// tip | "Tipp"
/// tip | Tipp
Um mehr über Statuscodes zu lernen, und welcher wofür verwendet wird, lesen Sie die <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" class="external-link" target="_blank"><abbr title="Mozilla Developer Network Mozilla-Entwickler-Netzwerk">MDN</abbr> Dokumentation über HTTP-Statuscodes</a>.
@@ -76,9 +74,7 @@ Um mehr über Statuscodes zu lernen, und welcher wofür verwendet wird, lesen Si
Schauen wir uns das vorherige Beispiel noch einmal an:
```Python hl_lines="6"
{!../../docs_src/response_status_code/tutorial001.py!}
```
{* ../../docs_src/response_status_code/tutorial001.py hl[6] *}
`201` ist der Statuscode für „Created“ („Erzeugt“).
@@ -86,15 +82,13 @@ Aber Sie müssen sich nicht daran erinnern, welcher dieser Codes was bedeutet.
Sie können die Hilfsvariablen von `fastapi.status` verwenden.
```Python hl_lines="1 6"
{!../../docs_src/response_status_code/tutorial002.py!}
```
{* ../../docs_src/response_status_code/tutorial002.py hl[1,6] *}
Diese sind nur eine Annehmlichkeit und enthalten dieselbe Nummer, aber auf diese Weise können Sie die Autovervollständigung Ihres Editors verwenden, um sie zu finden:
<img src="/img/tutorial/response-status-code/image02.png">
/// note | "Technische Details"
/// note | Technische Details
Sie können auch `from starlette import status` verwenden.

View File

@@ -8,35 +8,15 @@ Hier sind mehrere Möglichkeiten, das zu tun.
Sie können `examples` („Beispiele“) für ein Pydantic-Modell deklarieren, welche dem generierten JSON-Schema hinzugefügt werden.
//// tab | Python 3.10+ Pydantic v2
//// tab | Pydantic v2
```Python hl_lines="13-24"
{!> ../../docs_src/schema_extra_example/tutorial001_py310.py!}
```
{* ../../docs_src/schema_extra_example/tutorial001_py310.py hl[13:24] *}
////
//// tab | Python 3.10+ Pydantic v1
//// tab | Pydantic v1
```Python hl_lines="13-23"
{!> ../../docs_src/schema_extra_example/tutorial001_py310_pv1.py!}
```
////
//// tab | Python 3.8+ Pydantic v2
```Python hl_lines="15-26"
{!> ../../docs_src/schema_extra_example/tutorial001.py!}
```
////
//// tab | Python 3.8+ Pydantic v1
```Python hl_lines="15-25"
{!> ../../docs_src/schema_extra_example/tutorial001_pv1.py!}
```
{* ../../docs_src/schema_extra_example/tutorial001_pv1_py310.py hl[13:23] *}
////
@@ -58,7 +38,7 @@ Sie können `schema_extra` setzen, mit einem `dict`, das alle zusätzlichen Date
////
/// tip | "Tipp"
/// tip | Tipp
Mit derselben Technik können Sie das JSON-Schema erweitern und Ihre eigenen benutzerdefinierten Zusatzinformationen hinzufügen.
@@ -80,21 +60,7 @@ Mehr erfahren Sie am Ende dieser Seite.
Wenn Sie `Field()` mit Pydantic-Modellen verwenden, können Sie ebenfalls zusätzliche `examples` deklarieren:
//// tab | Python 3.10+
```Python hl_lines="2 8-11"
{!> ../../docs_src/schema_extra_example/tutorial002_py310.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="4 10-13"
{!> ../../docs_src/schema_extra_example/tutorial002.py!}
```
////
{* ../../docs_src/schema_extra_example/tutorial002_py310.py hl[2,8:11] *}
## `examples` im JSON-Schema OpenAPI
@@ -114,57 +80,7 @@ können Sie auch eine Gruppe von `examples` mit zusätzlichen Informationen dekl
Hier übergeben wir `examples`, welches ein einzelnes Beispiel für die in `Body()` erwarteten Daten enthält:
//// tab | Python 3.10+
```Python hl_lines="22-29"
{!> ../../docs_src/schema_extra_example/tutorial003_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="22-29"
{!> ../../docs_src/schema_extra_example/tutorial003_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="23-30"
{!> ../../docs_src/schema_extra_example/tutorial003_an.py!}
```
////
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="18-25"
{!> ../../docs_src/schema_extra_example/tutorial003_py310.py!}
```
////
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="20-27"
{!> ../../docs_src/schema_extra_example/tutorial003.py!}
```
////
{* ../../docs_src/schema_extra_example/tutorial003_an_py310.py hl[22:29] *}
### Beispiel in der Dokumentations-Benutzeroberfläche
@@ -176,57 +92,7 @@ Mit jeder der oben genannten Methoden würde es in `/docs` so aussehen:
Sie können natürlich auch mehrere `examples` übergeben:
//// tab | Python 3.10+
```Python hl_lines="23-38"
{!> ../../docs_src/schema_extra_example/tutorial004_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="23-38"
{!> ../../docs_src/schema_extra_example/tutorial004_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="24-39"
{!> ../../docs_src/schema_extra_example/tutorial004_an.py!}
```
////
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="19-34"
{!> ../../docs_src/schema_extra_example/tutorial004_py310.py!}
```
////
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="21-36"
{!> ../../docs_src/schema_extra_example/tutorial004.py!}
```
////
{* ../../docs_src/schema_extra_example/tutorial004_an_py310.py hl[23:38] *}
Wenn Sie das tun, werden die Beispiele Teil des internen **JSON-Schemas** für diese Body-Daten.
@@ -267,57 +133,7 @@ Jedes spezifische Beispiel-`dict` in den `examples` kann Folgendes enthalten:
Sie können es so verwenden:
//// tab | Python 3.10+
```Python hl_lines="23-49"
{!> ../../docs_src/schema_extra_example/tutorial005_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="23-49"
{!> ../../docs_src/schema_extra_example/tutorial005_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="24-50"
{!> ../../docs_src/schema_extra_example/tutorial005_an.py!}
```
////
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="19-45"
{!> ../../docs_src/schema_extra_example/tutorial005_py310.py!}
```
////
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
Bevorzugen Sie die `Annotated`-Version, falls möglich.
///
```Python hl_lines="21-47"
{!> ../../docs_src/schema_extra_example/tutorial005.py!}
```
////
{* ../../docs_src/schema_extra_example/tutorial005_an_py310.py hl[23:49] *}
### OpenAPI-Beispiele in der Dokumentations-Benutzeroberfläche
@@ -327,7 +143,7 @@ Wenn `openapi_examples` zu `Body()` hinzugefügt wird, würde `/docs` so aussehe
## Technische Details
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie bereits **FastAPI** Version **0.99.0 oder höher** verwenden, können Sie diese Details wahrscheinlich **überspringen**.
@@ -337,7 +153,7 @@ Sie können dies als eine kurze **Geschichtsstunde** zu OpenAPI und JSON Schema
///
/// warning | "Achtung"
/// warning | Achtung
Dies sind sehr technische Details zu den Standards **JSON Schema** und **OpenAPI**.

View File

@@ -38,7 +38,7 @@ Kopieren Sie das Beispiel in eine Datei `main.py`:
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -82,7 +82,7 @@ Sie werden etwa Folgendes sehen:
<img src="/img/tutorial/security/image01.png">
/// check | "Authorize-Button!"
/// check | Authorize-Button!
Sie haben bereits einen glänzenden, neuen „Authorize“-Button.
@@ -94,7 +94,7 @@ Und wenn Sie darauf klicken, erhalten Sie ein kleines Anmeldeformular zur Eingab
<img src="/img/tutorial/security/image02.png">
/// note | "Hinweis"
/// note | Hinweis
Es spielt keine Rolle, was Sie in das Formular eingeben, es wird noch nicht funktionieren. Wir kommen dahin.
@@ -172,7 +172,7 @@ Wenn wir eine Instanz der Klasse `OAuth2PasswordBearer` erstellen, übergeben wi
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -184,7 +184,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// tip | "Tipp"
/// tip | Tipp
Hier bezieht sich `tokenUrl="token"` auf eine relative URL `token`, die wir noch nicht erstellt haben. Da es sich um eine relative URL handelt, entspricht sie `./token`.
@@ -238,7 +238,7 @@ Jetzt können Sie dieses `oauth2_scheme` als Abhängigkeit `Depends` übergeben.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -254,7 +254,7 @@ Diese Abhängigkeit stellt einen `str` bereit, der dem Parameter `token` der *Pf
**FastAPI** weiß, dass es diese Abhängigkeit verwenden kann, um ein „Sicherheitsschema“ im OpenAPI-Schema (und der automatischen API-Dokumentation) zu definieren.
/// info | "Technische Details"
/// info | Technische Details
**FastAPI** weiß, dass es die Klasse `OAuth2PasswordBearer` (deklariert in einer Abhängigkeit) verwenden kann, um das Sicherheitsschema in OpenAPI zu definieren, da es von `fastapi.security.oauth2.OAuth2` erbt, das wiederum von `fastapi.security.base.SecurityBase` erbt.

View File

@@ -20,7 +20,7 @@ Im vorherigen Kapitel hat das Sicherheitssystem (das auf dem Dependency Injectio
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -68,7 +68,7 @@ So wie wir Pydantic zum Deklarieren von Bodys verwenden, können wir es auch üb
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -82,7 +82,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -130,7 +130,7 @@ So wie wir es zuvor in der *Pfadoperation* direkt gemacht haben, erhält unsere
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -144,7 +144,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -186,7 +186,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -200,7 +200,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -242,7 +242,7 @@ Und jetzt können wir wiederum `Depends` mit unserem `get_current_user` in der *
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -256,7 +256,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -272,7 +272,7 @@ Beachten Sie, dass wir als Typ von `current_user` das Pydantic-Modell `User` dek
Das wird uns innerhalb der Funktion bei Codevervollständigung und Typprüfungen helfen.
/// tip | "Tipp"
/// tip | Tipp
Sie erinnern sich vielleicht, dass Requestbodys ebenfalls mit Pydantic-Modellen deklariert werden.
@@ -346,7 +346,7 @@ Und alle diese Tausenden von *Pfadoperationen* können nur drei Zeilen lang sein
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -360,7 +360,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.

View File

@@ -32,7 +32,7 @@ Heutzutage ist es nicht sehr populär und wird kaum verwendet.
OAuth2 spezifiziert nicht, wie die Kommunikation verschlüsselt werden soll, sondern erwartet, dass Ihre Anwendung mit HTTPS bereitgestellt wird.
/// tip | "Tipp"
/// tip | Tipp
Im Abschnitt über **Deployment** erfahren Sie, wie Sie HTTPS mithilfe von Traefik und Let's Encrypt kostenlos einrichten.
@@ -89,7 +89,7 @@ OpenAPI definiert die folgenden Sicherheitsschemas:
* Diese automatische Erkennung ist es, die in der OpenID Connect Spezifikation definiert ist.
/// tip | "Tipp"
/// tip | Tipp
Auch die Integration anderer Authentifizierungs-/Autorisierungsanbieter wie Google, Facebook, Twitter, GitHub, usw. ist möglich und relativ einfach.

View File

@@ -44,7 +44,7 @@ $ pip install "python-jose[cryptography]"
Hier verwenden wir das empfohlene: <a href="https://cryptography.io/" class="external-link" target="_blank">pyca/cryptography</a>.
/// tip | "Tipp"
/// tip | Tipp
Dieses Tutorial verwendete zuvor <a href="https://pyjwt.readthedocs.io/" class="external-link" target="_blank">PyJWT</a>.
@@ -86,7 +86,7 @@ $ pip install "passlib[bcrypt]"
</div>
/// tip | "Tipp"
/// tip | Tipp
Mit `passlib` können Sie sogar konfigurieren, Passwörter zu lesen, die von **Django**, einem **Flask**-Sicherheit-Plugin, oder vielen anderen erstellt wurden.
@@ -102,7 +102,7 @@ Importieren Sie die benötigten Tools aus `passlib`.
Erstellen Sie einen PassLib-„Kontext“. Der wird für das Hashen und Verifizieren von Passwörtern verwendet.
/// tip | "Tipp"
/// tip | Tipp
Der PassLib-Kontext kann auch andere Hashing-Algorithmen verwenden, einschließlich deprecateter Alter, um etwa nur eine Verifizierung usw. zu ermöglichen.
@@ -144,7 +144,7 @@ Und noch eine, um einen Benutzer zu authentifizieren und zurückzugeben.
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -158,7 +158,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -170,7 +170,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// note | "Hinweis"
/// note | Hinweis
Wenn Sie sich die neue (gefakte) Datenbank `fake_users_db` anschauen, sehen Sie, wie das gehashte Passwort jetzt aussieht: `"$2b$12$EixZaYVK1fsbw1ZfbX3OXePaWxn96p36WQoeG6Lruj3vjPGga31lW"`.
@@ -230,7 +230,7 @@ Erstellen Sie eine Hilfsfunktion, um einen neuen Zugriffstoken zu generieren.
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -244,7 +244,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -290,7 +290,7 @@ Wenn der Token ungültig ist, geben Sie sofort einen HTTP-Fehler zurück.
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -304,7 +304,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -348,7 +348,7 @@ Erstellen Sie einen echten JWT-Zugriffstoken und geben Sie ihn zurück.
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -362,7 +362,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -436,7 +436,7 @@ Wenn Sie die Developer Tools öffnen, können Sie sehen, dass die gesendeten Dat
<img src="/img/tutorial/security/image10.png">
/// note | "Hinweis"
/// note | Hinweis
Beachten Sie den Header `Authorization` mit einem Wert, der mit `Bearer` beginnt.

View File

@@ -78,7 +78,7 @@ Importieren Sie zunächst `OAuth2PasswordRequestForm` und verwenden Sie es als A
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -92,7 +92,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -111,7 +111,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
* Einem optionalen `scope`-Feld als langem String, bestehend aus durch Leerzeichen getrennten Strings.
* Einem optionalen `grant_type` („Art der Anmeldung“).
/// tip | "Tipp"
/// tip | Tipp
Die OAuth2-Spezifikation *erfordert* tatsächlich ein Feld `grant_type` mit dem festen Wert `password`, aber `OAuth2PasswordRequestForm` erzwingt dies nicht.
@@ -136,7 +136,7 @@ Da es sich jedoch um einen häufigen Anwendungsfall handelt, wird er zur Vereinf
### Die Formulardaten verwenden
/// tip | "Tipp"
/// tip | Tipp
Die Instanz der Klassenabhängigkeit `OAuth2PasswordRequestForm` verfügt, statt eines Attributs `scope` mit dem durch Leerzeichen getrennten langen String, über das Attribut `scopes` mit einer tatsächlichen Liste von Strings, einem für jeden gesendeten Scope.
@@ -176,7 +176,7 @@ Für den Fehler verwenden wir die Exception `HTTPException`:
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -190,7 +190,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -252,7 +252,7 @@ Der Dieb kann also nicht versuchen, die gleichen Passwörter in einem anderen Sy
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -266,7 +266,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -310,7 +310,7 @@ Und es sollte einen `access_token` haben, mit einem String, der unseren Zugriffs
In diesem einfachen Beispiel gehen wir einfach völlig unsicher vor und geben denselben `username` wie der Token zurück.
/// tip | "Tipp"
/// tip | Tipp
Im nächsten Kapitel sehen Sie eine wirklich sichere Implementierung mit Passwort-Hashing und <abbr title="JSON Web Tokens">JWT</abbr>-Tokens.
@@ -344,7 +344,7 @@ Aber konzentrieren wir uns zunächst auf die spezifischen Details, die wir benö
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -358,7 +358,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -370,7 +370,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
////
/// tip | "Tipp"
/// tip | Tipp
Gemäß der Spezifikation sollten Sie ein JSON mit einem `access_token` und einem `token_type` zurückgeben, genau wie in diesem Beispiel.
@@ -420,7 +420,7 @@ In unserem Endpunkt erhalten wir also nur dann einen Benutzer, wenn der Benutzer
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -434,7 +434,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.

View File

@@ -11,7 +11,7 @@ Mit `StaticFiles` können Sie statische Dateien aus einem Verzeichnis automatisc
{!../../docs_src/static_files/tutorial001.py!}
```
/// note | "Technische Details"
/// note | Technische Details
Sie könnten auch `from starlette.staticfiles import StaticFiles` verwenden.

View File

@@ -30,7 +30,7 @@ Schreiben Sie einfache `assert`-Anweisungen mit den Standard-Python-Ausdrücken,
{!../../docs_src/app_testing/tutorial001.py!}
```
/// tip | "Tipp"
/// tip | Tipp
Beachten Sie, dass die Testfunktionen normal `def` und nicht `async def` sind.
@@ -40,7 +40,7 @@ Dadurch können Sie `pytest` ohne Komplikationen direkt nutzen.
///
/// note | "Technische Details"
/// note | Technische Details
Sie könnten auch `from starlette.testclient import TestClient` verwenden.
@@ -48,7 +48,7 @@ Sie könnten auch `from starlette.testclient import TestClient` verwenden.
///
/// tip | "Tipp"
/// tip | Tipp
Wenn Sie in Ihren Tests neben dem Senden von Anfragen an Ihre FastAPI-Anwendung auch `async`-Funktionen aufrufen möchten (z. B. asynchrone Datenbankfunktionen), werfen Sie einen Blick auf die [Async-Tests](../advanced/async-tests.md){.internal-link target=_blank} im Handbuch für fortgeschrittene Benutzer.
@@ -148,7 +148,7 @@ Beide *Pfadoperationen* erfordern einen `X-Token`-Header.
//// tab | Python 3.10+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.
@@ -162,7 +162,7 @@ Bevorzugen Sie die `Annotated`-Version, falls möglich.
//// tab | Python 3.8+ nicht annotiert
/// tip | "Tipp"
/// tip | Tipp
Bevorzugen Sie die `Annotated`-Version, falls möglich.

View File

@@ -28,7 +28,7 @@
///
/// note | "📡 "
/// note | 📡
👆 💪 ⚙️ `from starlette.responses import JSONResponse`.

View File

@@ -80,7 +80,7 @@ $ uvicorn main:app --root-path /api/v1
🚥 👆 ⚙️ Hypercorn, ⚫️ ✔️ 🎛 `--root-path`.
/// note | "📡 "
/// note | 📡
🔫 🔧 🔬 `root_path` 👉 ⚙️ 💼.

View File

@@ -121,7 +121,7 @@
✔️ 🤯 👈 👆 💪 ⚙️ `Response` 📨 🕳 🙆, ⚖️ ✍ 🛃 🎧-🎓.
/// note | "📡 "
/// note | 📡
👆 💪 ⚙️ `from starlette.responses import HTMLResponse`.

View File

@@ -43,7 +43,7 @@ app.add_middleware(UnicornMiddleware, some_config="rainbow")
**FastAPI** 🔌 📚 🛠️ ⚠ ⚙️ 💼, 👥 🔜 👀 ⏭ ❔ ⚙️ 👫.
/// note | "📡 "
/// note | 📡
⏭ 🖼, 👆 💪 ⚙️ `from starlette.middleware.something import SomethingMiddleware`.

View File

@@ -74,7 +74,7 @@
🕐❔ 👆 📣 *➡ 🛠️* 👆 🈸, **FastAPI** 🔁 🏗 🔗 🗃 🔃 👈 *➡ 🛠️* 🔌 🗄 🔗.
/// note | "📡 "
/// note | 📡
🗄 🔧 ⚫️ 🤙 <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object" class="external-link" target="_blank">🛠️ 🎚</a>.

View File

@@ -42,7 +42,7 @@
### 🌅
/// note | "📡 "
/// note | 📡
👆 💪 ⚙️ `from starlette.responses import Response` ⚖️ `from starlette.responses import JSONResponse`.

View File

@@ -38,7 +38,7 @@
{!../../docs_src/response_directly/tutorial001.py!}
```
/// note | "📡 "
/// note | 📡
👆 💪 ⚙️ `from starlette.responses import JSONResponse`.

View File

@@ -28,7 +28,7 @@
{!../../docs_src/response_headers/tutorial001.py!}
```
/// note | "📡 "
/// note | 📡
👆 💪 ⚙️ `from starlette.responses import Response` ⚖️ `from starlette.responses import JSONResponse`.

View File

@@ -134,7 +134,7 @@ Oauth2⃣ 👫 🎻.
{!../../docs_src/security/tutorial005.py!}
```
/// info | "📡 "
/// info | 📡
`Security` 🤙 🏿 `Depends`, &amp; ⚫️ ✔️ 1 🔢 👈 👥 🔜 👀 ⏪.

View File

@@ -43,7 +43,7 @@ $ pip install jinja2
///
/// note | "📡 "
/// note | 📡
👆 💪 ⚙️ `from starlette.templating import Jinja2Templates`.

View File

@@ -49,7 +49,7 @@
👆 💪 ✍ 🌅 🔃 <a href="https://www.starlette.io/requests/" class="external-link" target="_blank">`Request` 🎚 🛂 💃 🧾 🕸</a>.
/// note | "📡 "
/// note | 📡
👆 💪 ⚙️ `from starlette.requests import Request`.

View File

@@ -50,7 +50,7 @@ $ pip install websockets
{!../../docs_src/websockets/tutorial001.py!}
```
/// note | "📡 "
/// note | 📡
👆 💪 ⚙️ `from starlette.websockets import WebSocket`.

View File

@@ -36,7 +36,7 @@
///
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
✔️ 🏧 🛠️ 🧾 🕸 👩‍💻 🔢.
@@ -56,7 +56,7 @@
👐 🦁 🏺, ⚫️ 😑 💖 👍 🏏 🏗 🔗. ⏭ 👜 🔎 "✳ 🎂 🛠️" 🏺.
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
◾-🛠️. ⚒ ⚫️ ⏩ 🌀 &amp; 🏏 🧰 &amp; 🍕 💪.
@@ -98,7 +98,7 @@ def read_url():
👀 🔀 `requests.get(...)` &amp; `@app.get(...)`.
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
* ✔️ 🙅 &amp; 🏋️ 🛠️.
* ⚙️ 🇺🇸🔍 👩‍🔬 📛 (🛠️) 🔗, 🎯 &amp; 🏋️ 🌌.
@@ -118,7 +118,7 @@ def read_url():
👈 ⚫️❔ 🕐❔ 💬 🔃 ⏬ 2⃣.0️⃣ ⚫️ ⚠ 💬 "🦁", &amp; ⏬ 3 "🗄".
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
🛠️ &amp; ⚙️ 📂 🐩 🛠️ 🔧, ↩️ 🛃 🔗.
@@ -147,7 +147,7 @@ def read_url():
✋️ ⚫️ ✍ ⏭ 📤 🔀 🐍 🆎 🔑. , 🔬 🔠 <abbr title="the definition of how data should be formed">🔗</abbr> 👆 💪 ⚙️ 🎯 🇨🇻 &amp; 🎓 🚚 🍭.
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
⚙️ 📟 🔬 "🔗" 👈 🚚 💽 🆎 &amp; 🔬, 🔁.
@@ -169,7 +169,7 @@ Webarg ✍ 🎏 🍭 👩‍💻.
///
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
✔️ 🏧 🔬 📨 📨 💽.
@@ -199,7 +199,7 @@ APISpec ✍ 🎏 🍭 👩‍💻.
///
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
🐕‍🦺 📂 🐩 🛠️, 🗄.
@@ -231,7 +231,7 @@ APISpec ✍ 🎏 🍭 👩‍💻.
///
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
🏗 🗄 🔗 🔁, ⚪️➡️ 🎏 📟 👈 🔬 🛠️ &amp; 🔬.
@@ -251,7 +251,7 @@ APISpec ✍ 🎏 🍭 👩‍💻.
⚫️ 💪 🚫 🍵 🔁 🏷 📶 👍. , 🚥 🎻 💪 📨 🎻 🎚 👈 ✔️ 🔘 🏑 👈 🔄 🐦 🎻 🎚, ⚫️ 🚫🔜 ☑ 📄 &amp; ✔.
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
⚙️ 🐍 🆎 ✔️ 👑 👨‍🎨 🐕‍🦺.
@@ -263,7 +263,7 @@ APISpec ✍ 🎏 🍭 👩‍💻.
⚫️ 🕐 🥇 📶 ⏩ 🐍 🛠️ ⚓️ 🔛 `asyncio`. ⚫️ ⚒ 📶 🎏 🏺.
/// note | "📡 "
/// note | 📡
⚫️ ⚙️ <a href="https://github.com/MagicStack/uvloop" class="external-link" target="_blank">`uvloop`</a> ↩️ 🔢 🐍 `asyncio` ➰. 👈 ⚫️❔ ⚒ ⚫️ ⏩.
@@ -271,7 +271,7 @@ APISpec ✍ 🎏 🍭 👩‍💻.
///
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
🔎 🌌 ✔️ 😜 🎭.
@@ -287,7 +287,7 @@ APISpec ✍ 🎏 🍭 👩‍💻.
, 💽 🔬, 🛠️, &amp; 🧾, ✔️ ⌛ 📟, 🚫 🔁. ⚖️ 👫 ✔️ 🛠️ 🛠️ 🔛 🔝 🦅, 💖 🤗. 👉 🎏 🔺 🔨 🎏 🛠️ 👈 😮 🦅 🔧, ✔️ 1⃣ 📨 🎚 &amp; 1⃣ 📨 🎚 🔢.
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
🔎 🌌 🤚 👑 🎭.
@@ -313,7 +313,7 @@ APISpec ✍ 🎏 🍭 👩‍💻.
🛣 📣 👁 🥉, ⚙️ 🔢 📣 🎏 🥉 (↩️ ⚙️ 👨‍🎨 👈 💪 🥉 ▶️️ 🔛 🔝 🔢 👈 🍵 🔗). 👉 🔐 ❔ ✳ 🔨 ⚫️ 🌘 ❔ 🏺 (&amp; 💃) 🔨 ⚫️. ⚫️ 🎏 📟 👜 👈 📶 😆 🔗.
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
🔬 🔬 💽 🆎 ⚙️ "🔢" 💲 🏷 🔢. 👉 📉 👨‍🎨 🐕‍🦺, &amp; ⚫️ 🚫 💪 Pydantic ⏭.
@@ -341,7 +341,7 @@ APISpec ✍ 🎏 🍭 👩‍💻.
///
/// check | "💭 😮 **FastAPI**"
/// check | 💭 😮 **FastAPI**
🤗 😮 🍕 APIStar, &amp; 1⃣ 🧰 👤 🔎 🏆 👍, 🌟 APIStar.
@@ -385,7 +385,7 @@ APIStar ✍ ✡ 🇺🇸🏛. 🎏 👨 👈 ✍:
///
/// check | "😮 **FastAPI** "
/// check | 😮 **FastAPI**
🔀.
@@ -409,7 +409,7 @@ Pydantic 🗃 🔬 💽 🔬, 🛠️ &amp; 🧾 (⚙️ 🎻 🔗) ⚓️ 🔛
⚫️ ⭐ 🍭. 👐 ⚫️ ⏩ 🌘 🍭 📇. &amp; ⚫️ ⚓️ 🔛 🎏 🐍 🆎 🔑, 👨‍🎨 🐕‍🦺 👑.
/// check | "**FastAPI** ⚙️ ⚫️"
/// check | **FastAPI** ⚙️ ⚫️
🍵 🌐 💽 🔬, 💽 🛠️ &amp; 🏧 🏷 🧾 (⚓️ 🔛 🎻 🔗).
@@ -444,7 +444,7 @@ Pydantic 🗃 🔬 💽 🔬, 🛠️ &amp; 🧾 (⚙️ 🎻 🔗) ⚓️ 🔛
👈 1⃣ 👑 👜 👈 **FastAPI** 🚮 🔛 🔝, 🌐 ⚓️ 🔛 🐍 🆎 🔑 (⚙️ Pydantic). 👈, 🔗 💉 ⚙️, 💂‍♂ 🚙, 🗄 🔗 ⚡, ♒️.
/// note | "📡 "
/// note | 📡
🔫 🆕 "🐩" 🛠️ ✳ 🐚 🏉 👨‍🎓. ⚫️ 🚫 "🐍 🐩" (🇩🇬), 👐 👫 🛠️ 🔨 👈.
@@ -452,7 +452,7 @@ Pydantic 🗃 🔬 💽 🔬, 🛠️ &amp; 🧾 (⚙️ 🎻 🔗) ⚓️ 🔛
///
/// check | "**FastAPI** ⚙️ ⚫️"
/// check | **FastAPI** ⚙️ ⚫️
🍵 🌐 🐚 🕸 🍕. ❎ ⚒ 🔛 🔝.
@@ -470,7 +470,7 @@ Uvicorn 🌩-⏩ 🔫 💽, 🏗 🔛 uvloop &amp; httptool.
⚫️ 👍 💽 💃 &amp; **FastAPI**.
/// check | "**FastAPI** 👍 ⚫️"
/// check | **FastAPI** 👍 ⚫️
👑 🕸 💽 🏃 **FastAPI** 🈸.

View File

@@ -1,493 +0,0 @@
# 🛠️ - 📉
🥇, 👆 💪 💚 👀 🔰 🌌 [ FastAPI &amp; 🤚 ](help-fastapi.md){.internal-link target=_blank}.
## 🛠️
🚥 👆 ⏪ 🖖 🗃 &amp; 👆 💭 👈 👆 💪 ⏬ 🤿 📟, 📥 📄 ⚒ 🆙 👆 🌐.
### 🕹 🌐 ⏮️ `venv`
👆 💪 ✍ 🕹 🌐 📁 ⚙️ 🐍 `venv` 🕹:
<div class="termy">
```console
$ python -m venv env
```
</div>
👈 🔜 ✍ 📁 `./env/` ⏮️ 🐍 💱 &amp; ⤴️ 👆 🔜 💪 ❎ 📦 👈 ❎ 🌐.
### 🔓 🌐
🔓 🆕 🌐 ⏮️:
//// tab | 💾, 🇸🇻
<div class="termy">
```console
$ source ./env/bin/activate
```
</div>
////
//// tab | 🚪 📋
<div class="termy">
```console
$ .\env\Scripts\Activate.ps1
```
</div>
////
//// tab | 🚪 🎉
⚖️ 🚥 👆 ⚙️ 🎉 🖥 (✅ <a href="https://gitforwindows.org/" class="external-link" target="_blank">🐛 🎉</a>):
<div class="termy">
```console
$ source ./env/Scripts/activate
```
</div>
////
✅ ⚫️ 👷, ⚙️:
//// tab | 💾, 🇸🇻, 🚪 🎉
<div class="termy">
```console
$ which pip
some/directory/fastapi/env/bin/pip
```
</div>
////
//// tab | 🚪 📋
<div class="termy">
```console
$ Get-Command pip
some/directory/fastapi/env/bin/pip
```
</div>
////
🚥 ⚫️ 🎦 `pip` 💱 `env/bin/pip` ⤴️ ⚫️ 👷. 👶
⚒ 💭 👆 ✔️ 📰 🐖 ⏬ 🔛 👆 🕹 🌐 ❎ ❌ 🔛 ⏭ 📶:
<div class="termy">
```console
$ python -m pip install --upgrade pip
---> 100%
```
</div>
/// tip
🔠 🕰 👆 ❎ 🆕 📦 ⏮️ `pip` 🔽 👈 🌐, 🔓 🌐 🔄.
👉 ⚒ 💭 👈 🚥 👆 ⚙️ 📶 📋 ❎ 👈 📦, 👆 ⚙️ 1⃣ ⚪️➡️ 👆 🇧🇿 🌐 &amp; 🚫 🙆 🎏 👈 💪 ❎ 🌐.
///
### 🐖
⏮️ 🔓 🌐 🔬 🔛:
<div class="termy">
```console
$ pip install -r requirements.txt
---> 100%
```
</div>
⚫️ 🔜 ❎ 🌐 🔗 &amp; 👆 🇧🇿 FastAPI 👆 🇧🇿 🌐.
#### ⚙️ 👆 🇧🇿 FastAPI
🚥 👆 ✍ 🐍 📁 👈 🗄 &amp; ⚙️ FastAPI, &amp; 🏃 ⚫️ ⏮️ 🐍 ⚪️➡️ 👆 🇧🇿 🌐, ⚫️ 🔜 ⚙️ 👆 🇧🇿 FastAPI 📟.
&amp; 🚥 👆 👈 🇧🇿 FastAPI 📟, ⚫️ ❎ ⏮️ `-e`, 🕐❔ 👆 🏃 👈 🐍 📁 🔄, ⚫️ 🔜 ⚙️ 🍋 ⏬ FastAPI 👆 ✍.
👈 🌌, 👆 🚫 ✔️ "❎" 👆 🇧🇿 ⏬ 💪 💯 🔠 🔀.
### 📁
📤 ✍ 👈 👆 💪 🏃 👈 🔜 📁 &amp; 🧹 🌐 👆 📟:
<div class="termy">
```console
$ bash scripts/format.sh
```
</div>
⚫️ 🔜 🚘-😇 🌐 👆 🗄.
⚫️ 😇 👫 ☑, 👆 💪 ✔️ FastAPI ❎ 🌐 👆 🌐, ⏮️ 📋 📄 🔛 ⚙️ `-e`.
## 🩺
🥇, ⚒ 💭 👆 ⚒ 🆙 👆 🌐 🔬 🔛, 👈 🔜 ❎ 🌐 📄.
🧾 ⚙️ <a href="https://www.mkdocs.org/" class="external-link" target="_blank">⬜</a>.
&amp; 📤 🧰/✍ 🥉 🍵 ✍ `./scripts/docs.py`.
/// tip
👆 🚫 💪 👀 📟 `./scripts/docs.py`, 👆 ⚙️ ⚫️ 📋 ⏸.
///
🌐 🧾 ✍ 📁 📁 `./docs/en/`.
📚 🔰 ✔️ 🍫 📟.
🌅 💼, 👫 🍫 📟 ☑ 🏁 🈸 👈 💪 🏃.
👐, 👈 🍫 📟 🚫 ✍ 🔘 ✍, 👫 🐍 📁 `./docs_src/` 📁.
&amp; 👈 🐍 📁 🔌/💉 🧾 🕐❔ 🏭 🕸.
### 🩺 💯
🏆 💯 🤙 🏃 🛡 🖼 📁 🧾.
👉 ⚒ 💭 👈:
* 🧾 🆙 📅.
* 🧾 🖼 💪 🏃.
* 🌅 ⚒ 📔 🧾, 🚚 💯 💰.
⏮️ 🇧🇿 🛠️, 📤 ✍ 👈 🏗 🕸 &amp; ✅ 🙆 🔀, 🖖-🔫:
<div class="termy">
```console
$ python ./scripts/docs.py live
<span style="color: green;">[INFO]</span> Serving on http://127.0.0.1:8008
<span style="color: green;">[INFO]</span> Start watching changes
<span style="color: green;">[INFO]</span> Start detecting changes
```
</div>
⚫️ 🔜 🍦 🧾 🔛 `http://127.0.0.1:8008`.
👈 🌌, 👆 💪 ✍ 🧾/ 📁 &amp; 👀 🔀 🖖.
#### 🏎 ✳ (📦)
👩‍🌾 📥 🎦 👆 ❔ ⚙️ ✍ `./scripts/docs.py` ⏮️ `python` 📋 🔗.
✋️ 👆 💪 ⚙️ <a href="https://typer.tiangolo.com/typer-cli/" class="external-link" target="_blank">🏎 ✳</a>, &amp; 👆 🔜 🤚 ✍ 👆 📶 📋 ⏮️ ❎ 🛠️.
🚥 👆 ❎ 🏎 ✳, 👆 💪 ❎ 🛠️ ⏮️:
<div class="termy">
```console
$ typer --install-completion
zsh completion installed in /home/user/.bashrc.
Completion will take effect once you restart the terminal.
```
</div>
### 📱 &amp; 🩺 🎏 🕰
🚥 👆 🏃 🖼 ⏮️, ✅:
<div class="termy">
```console
$ uvicorn tutorial001:app --reload
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
```
</div>
Uvicorn 🔢 🔜 ⚙️ ⛴ `8000`, 🧾 🔛 ⛴ `8008` 🏆 🚫 ⚔.
### ✍
⏮️ ✍ 📶 🌅 👍 ❗ &amp; ⚫️ 💪 🚫 🔨 🍵 ⚪️➡️ 👪. 👶 👶
📥 📶 ⏮️ ✍.
#### 💁‍♂ &amp; 📄
* ✅ ⏳ <a href="https://github.com/fastapi/fastapi/pulls" class="external-link" target="_blank">♻ 🚲 📨</a> 👆 🇪🇸 &amp; 🚮 📄 ✔ 🔀 ⚖️ ✔ 👫.
/// tip
👆 💪 <a href="https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request" class="external-link" target="_blank">🚮 🏤 ⏮️ 🔀 🔑</a> ♻ 🚲 📨.
✅ 🩺 🔃 <a href="https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews" class="external-link" target="_blank">❎ 🚲 📨 📄</a> ✔ ⚫️ ⚖️ 📨 🔀.
///
* ✅ <a href="https://github.com/fastapi/fastapi/issues" class="external-link" target="_blank">❔</a> 👀 🚥 📤 1⃣ 🛠️ ✍ 👆 🇪🇸.
* 🚮 👁 🚲 📨 📍 📃 💬. 👈 🔜 ⚒ ⚫️ 🌅 ⏩ 🎏 📄 ⚫️.
🇪🇸 👤 🚫 💬, 👤 🔜 ⌛ 📚 🎏 📄 ✍ ⏭ 🔗.
* 👆 💪 ✅ 🚥 📤 ✍ 👆 🇪🇸 &amp; 🚮 📄 👫, 👈 🔜 👤 💭 👈 ✍ ☑ &amp; 👤 💪 🔗 ⚫️.
* ⚙️ 🎏 🐍 🖼 &amp; 🕴 💬 ✍ 🩺. 👆 🚫 ✔️ 🔀 🕳 👉 👷.
* ⚙️ 🎏 🖼, 📁 📛, &amp; 🔗. 👆 🚫 ✔️ 🔀 🕳 ⚫️ 👷.
* ✅ 2⃣-🔤 📟 🇪🇸 👆 💚 💬 👆 💪 ⚙️ 🏓 <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" class="external-link" target="_blank">📇 💾 6⃣3⃣9⃣-1⃣ 📟</a>.
#### ♻ 🇪🇸
➡️ 💬 👆 💚 💬 📃 🇪🇸 👈 ⏪ ✔️ ✍ 📃, 💖 🇪🇸.
💼 🇪🇸, 2⃣-🔤 📟 `es`. , 📁 🇪🇸 ✍ 🔎 `docs/es/`.
/// tip
👑 ("🛂") 🇪🇸 🇪🇸, 🔎 `docs/en/`.
///
🔜 🏃 🖖 💽 🩺 🇪🇸:
<div class="termy">
```console
// Use the command "live" and pass the language code as a CLI argument
$ python ./scripts/docs.py live es
<span style="color: green;">[INFO]</span> Serving on http://127.0.0.1:8008
<span style="color: green;">[INFO]</span> Start watching changes
<span style="color: green;">[INFO]</span> Start detecting changes
```
</div>
🔜 👆 💪 🚶 <a href="http://127.0.0.1:8008" class="external-link" target="_blank">http://127.0.0.1:8008</a> &amp; 👀 👆 🔀 🖖.
🚥 👆 👀 FastAPI 🩺 🕸, 👆 🔜 👀 👈 🔠 🇪🇸 ✔️ 🌐 📃. ✋️ 📃 🚫 💬 &amp; ✔️ 📨 🔃 ❌ ✍.
✋️ 🕐❔ 👆 🏃 ⚫️ 🌐 💖 👉, 👆 🔜 🕴 👀 📃 👈 ⏪ 💬.
🔜 ➡️ 💬 👈 👆 💚 🚮 ✍ 📄 [](features.md){.internal-link target=_blank}.
* 📁 📁:
```
docs/en/docs/features.md
```
* 📋 ⚫️ ⚫️❔ 🎏 🗺 ✋️ 🇪🇸 👆 💚 💬, ✅:
```
docs/es/docs/features.md
```
/// tip
👀 👈 🕴 🔀 ➡ &amp; 📁 📛 🇪🇸 📟, ⚪️➡️ `en` `es`.
///
* 🔜 📂 ⬜ 📁 📁 🇪🇸:
```
docs/en/mkdocs.yml
```
* 🔎 🥉 🌐❔ 👈 `docs/features.md` 🔎 📁 📁. 👱 💖:
```YAML hl_lines="8"
site_name: FastAPI
# More stuff
nav:
- FastAPI: index.md
- Languages:
- en: /
- es: /es/
- features.md
```
* 📂 ⬜ 📁 📁 🇪🇸 👆 ✍, ✅:
```
docs/es/mkdocs.yml
```
* 🚮 ⚫️ 📤 ☑ 🎏 🗺 ⚫️ 🇪🇸, ✅:
```YAML hl_lines="8"
site_name: FastAPI
# More stuff
nav:
- FastAPI: index.md
- Languages:
- en: /
- es: /es/
- features.md
```
⚒ 💭 👈 🚥 📤 🎏 ⛔, 🆕 ⛔ ⏮️ 👆 ✍ ⚫️❔ 🎏 ✔ 🇪🇸 ⏬.
🚥 👆 🚶 👆 🖥 👆 🔜 👀 👈 🔜 🩺 🎦 👆 🆕 📄. 👶
🔜 👆 💪 💬 ⚫️ 🌐 &amp; 👀 ❔ ⚫️ 👀 👆 🖊 📁.
#### 🆕 🇪🇸
➡️ 💬 👈 👆 💚 🚮 ✍ 🇪🇸 👈 🚫 💬, 🚫 📃.
➡️ 💬 👆 💚 🚮 ✍ 🇭🇹, &amp; ⚫️ 🚫 📤 🩺.
✅ 🔗 ⚪️➡️ 🔛, 📟 "🇭🇹" `ht`.
⏭ 🔁 🏃 ✍ 🏗 🆕 ✍ 📁:
<div class="termy">
```console
// Use the command new-lang, pass the language code as a CLI argument
$ python ./scripts/docs.py new-lang ht
Successfully initialized: docs/ht
Updating ht
Updating en
```
</div>
🔜 👆 💪 ✅ 👆 📟 👨‍🎨 ⏳ ✍ 📁 `docs/ht/`.
/// tip
✍ 🥇 🚲 📨 ⏮️ 👉, ⚒ 🆙 📳 🆕 🇪🇸, ⏭ ❎ ✍.
👈 🌌 🎏 💪 ⏮️ 🎏 📃 ⏪ 👆 👷 🔛 🥇 🕐. 👶
///
▶️ ✍ 👑 📃, `docs/ht/index.md`.
⤴️ 👆 💪 😣 ⏮️ ⏮️ 👩‍🌾, "♻ 🇪🇸".
##### 🆕 🇪🇸 🚫 🐕‍🦺
🚥 🕐❔ 🏃‍♂ 🖖 💽 ✍ 👆 🤚 ❌ 🔃 🇪🇸 🚫 🐕‍🦺, 🕳 💖:
```
raise TemplateNotFound(template)
jinja2.exceptions.TemplateNotFound: partials/language/xx.html
```
👈 ⛓ 👈 🎢 🚫 🐕‍🦺 👈 🇪🇸 (👉 💼, ⏮️ ❌ 2⃣-🔤 📟 `xx`).
✋️ 🚫 😟, 👆 💪 ⚒ 🎢 🇪🇸 🇪🇸 &amp; ⤴️ 💬 🎚 🩺.
🚥 👆 💪 👈, ✍ `mkdocs.yml` 👆 🆕 🇪🇸, ⚫️ 🔜 ✔️ 🕳 💖:
```YAML hl_lines="5"
site_name: FastAPI
# More stuff
theme:
# More stuff
language: xx
```
🔀 👈 🇪🇸 ⚪️➡️ `xx` (⚪️➡️ 👆 🇪🇸 📟) `en`.
⤴️ 👆 💪 ▶️ 🖖 💽 🔄.
#### 🎮 🏁
🕐❔ 👆 ⚙️ ✍ `./scripts/docs.py` ⏮️ `live` 📋 ⚫️ 🕴 🎦 📁 &amp; ✍ 💪 ⏮️ 🇪🇸.
✋️ 🕐 👆 🔨, 👆 💪 💯 ⚫️ 🌐 ⚫️ 🔜 👀 💳.
👈, 🥇 🏗 🌐 🩺:
<div class="termy">
```console
// Use the command "build-all", this will take a bit
$ python ./scripts/docs.py build-all
Updating es
Updating en
Building docs for: en
Building docs for: es
Successfully built docs for: es
Copying en index.md to README.md
```
</div>
👈 🏗 🌐 🩺 `./docs_build/` 🔠 🇪🇸. 👉 🔌 ❎ 🙆 📁 ⏮️ ❌ ✍, ⏮️ 🗒 💬 👈 "👉 📁 🚫 ✔️ ✍". ✋️ 👆 🚫 ✔️ 🕳 ⏮️ 👈 📁.
⤴️ ⚫️ 🏗 🌐 👈 🔬 ⬜ 🕸 🔠 🇪🇸, 🌀 👫, &amp; 🏗 🏁 🔢 `./site/`.
⤴️ 👆 💪 🍦 👈 ⏮️ 📋 `serve`:
<div class="termy">
```console
// Use the command "serve" after running "build-all"
$ python ./scripts/docs.py serve
Warning: this is a very simple server. For development, use mkdocs serve instead.
This is here only to preview a site with translations already built.
Make sure you run the build-all command first.
Serving at: http://127.0.0.1:8008
```
</div>
## 💯
📤 ✍ 👈 👆 💪 🏃 🌐 💯 🌐 📟 &amp; 🏗 💰 📄 🕸:
<div class="termy">
```console
$ bash scripts/test-cov-html.sh
```
</div>
👉 📋 🏗 📁 `./htmlcov/`, 🚥 👆 📂 📁 `./htmlcov/index.html` 👆 🖥, 👆 💪 🔬 🖥 🇹🇼 📟 👈 📔 💯, &amp; 👀 🚥 📤 🙆 🇹🇼 ❌.

View File

@@ -60,7 +60,7 @@
{!../../docs_src/custom_request_and_route/tutorial001.py!}
```
/// note | "📡 "
/// note | 📡
`Request` ✔️ `request.scope` 🔢, 👈 🐍 `dict` ⚗ 🗃 🔗 📨.

Some files were not shown because too many files have changed in this diff Show More