mirror
/
tiangolo.fastapi
mirror of https://github.com/tiangolo/fastapi
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Merge branch 'master' into fix-duplicate-special-dependency-handling

pull/12406/head
Peter Volf 7 months ago
committed by GitHub
parent
c872fb7ecc 44cfb2f4f5
commit
5c4b148ca8
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
8 changed files with 37 additions and 310 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      .github/workflows/deploy-docs.yml
  2. 90
      docs/en/docs/advanced/security/http-basic-auth.md
  3. 16
      docs/en/docs/how-to/configure-swagger-ui.md
  4. 162
      docs/en/docs/how-to/separate-openapi-schemas.md
  5. 40
      docs/en/docs/python-types.md
  6. 7
      docs/en/docs/release-notes.md
  7. 28
      docs/en/docs/tutorial/first-steps.md
  8. 2
      docs/en/docs/tutorial/security/oauth2-jwt.md

2
.github/workflows/deploy-docs.yml
View File

@ -64,7 +64,7 @@ jobs:
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 ) }} 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 ) }}
# TODO: Use v3 when it's fixed, probably in v3.11 # TODO: Use v3 when it's fixed, probably in v3.11
# https://github.com/cloudflare/wrangler-action/issues/307 # https://github.com/cloudflare/wrangler-action/issues/307
uses: cloudflare/wrangler-action@v3.9 uses: cloudflare/wrangler-action@v3.11
# uses: cloudflare/wrangler-action@v3 # uses: cloudflare/wrangler-action@v3
with: with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}

90
docs/en/docs/advanced/security/http-basic-auth.md
View File

@ -20,35 +20,7 @@ Then, when you type that username and password, the browser sends them in the he
* It returns an object of type `HTTPBasicCredentials`: * It returns an object of type `HTTPBasicCredentials`:
* It contains the `username` and `password` sent. * It contains the `username` and `password` sent.
//// tab | Python 3.9+ {* ../../docs_src/security/tutorial006_an_py39.py hl[4,8,12] *}
```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+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="2 6 10"
{!> ../../docs_src/security/tutorial006.py!}
```
////
When you try to open the URL for the first time (or click the "Execute" button in the docs) the browser will ask you for your username and password: When you try to open the URL for the first time (or click the "Execute" button in the docs) the browser will ask you for your username and password:
@ -68,35 +40,7 @@ To handle that, we first convert the `username` and `password` to `bytes` encodi
Then we can use `secrets.compare_digest()` to ensure that `credentials.username` is `"stanleyjobson"`, and that `credentials.password` is `"swordfish"`. Then we can use `secrets.compare_digest()` to ensure that `credentials.username` is `"stanleyjobson"`, and that `credentials.password` is `"swordfish"`.
//// tab | Python 3.9+ {* ../../docs_src/security/tutorial007_an_py39.py hl[1,12:24] *}
```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+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="1 11-21"
{!> ../../docs_src/security/tutorial007.py!}
```
////
This would be similar to: This would be similar to:
@ -160,32 +104,4 @@ That way, using `secrets.compare_digest()` in your application code, it will be
After detecting that the credentials are incorrect, return an `HTTPException` with a status code 401 (the same returned when no credentials are provided) and add the header `WWW-Authenticate` to make the browser show the login prompt again: After detecting that the credentials are incorrect, return an `HTTPException` with a status code 401 (the same returned when no credentials are provided) and add the header `WWW-Authenticate` to make the browser show the login prompt again:
//// tab | Python 3.9+ {* ../../docs_src/security/tutorial007_an_py39.py hl[26:30] *}
```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+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="23-27"
{!> ../../docs_src/security/tutorial007.py!}
```
////

16
docs/en/docs/how-to/configure-swagger-ui.md
View File

@ -18,9 +18,7 @@ Without changing the settings, syntax highlighting is enabled by default:
But you can disable it by setting `syntaxHighlight` to `False`: But you can disable it by setting `syntaxHighlight` to `False`:
```Python hl_lines="3" {* ../../docs_src/configure_swagger_ui/tutorial001.py hl[3] *}
{!../../docs_src/configure_swagger_ui/tutorial001.py!}
```
...and then Swagger UI won't show the syntax highlighting anymore: ...and then Swagger UI won't show the syntax highlighting anymore:
@ -30,9 +28,7 @@ But you can disable it by setting `syntaxHighlight` to `False`:
The same way you could set the syntax highlighting theme with the key `"syntaxHighlight.theme"` (notice that it has a dot in the middle): The same way you could set the syntax highlighting theme with the key `"syntaxHighlight.theme"` (notice that it has a dot in the middle):
```Python hl_lines="3" {* ../../docs_src/configure_swagger_ui/tutorial002.py hl[3] *}
{!../../docs_src/configure_swagger_ui/tutorial002.py!}
```
That configuration would change the syntax highlighting color theme: That configuration would change the syntax highlighting color theme:
@ -44,17 +40,13 @@ FastAPI includes some default configuration parameters appropriate for most of t
It includes these default configurations: It includes these default configurations:
```Python {* ../../fastapi/openapi/docs.py ln[8:23] hl[17:23] *}
{!../../fastapi/openapi/docs.py[ln:7-23]!}
```
You can override any of them by setting a different value in the argument `swagger_ui_parameters`. You can override any of them by setting a different value in the argument `swagger_ui_parameters`.
For example, to disable `deepLinking` you could pass these settings to `swagger_ui_parameters`: For example, to disable `deepLinking` you could pass these settings to `swagger_ui_parameters`:
```Python hl_lines="3" {* ../../docs_src/configure_swagger_ui/tutorial003.py hl[3] *}
{!../../docs_src/configure_swagger_ui/tutorial003.py!}
```
## Other Swagger UI Parameters ## Other Swagger UI Parameters

162
docs/en/docs/how-to/separate-openapi-schemas.md
View File

@ -10,123 +10,13 @@ Let's see how that works and how to change it if you need to do that.
Let's say you have a Pydantic model with default values, like this one: Let's say you have a Pydantic model with default values, like this one:
//// tab | Python 3.10+ {* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:7] hl[7] *}
```Python hl_lines="7"
{!> ../../docs_src/separate_openapi_schemas/tutorial001_py310.py[ln:1-7]!}
# Code below omitted 👇
```
<details>
<summary>👀 Full file preview</summary>
```Python
{!> ../../docs_src/separate_openapi_schemas/tutorial001_py310.py!}
```
</details>
////
//// tab | Python 3.9+
```Python hl_lines="9"
{!> ../../docs_src/separate_openapi_schemas/tutorial001_py39.py[ln:1-9]!}
# Code below omitted 👇
```
<details>
<summary>👀 Full file preview</summary>
```Python
{!> ../../docs_src/separate_openapi_schemas/tutorial001_py39.py!}
```
</details>
////
//// tab | Python 3.8+
```Python hl_lines="9"
{!> ../../docs_src/separate_openapi_schemas/tutorial001.py[ln:1-9]!}
# Code below omitted 👇
```
<details>
<summary>👀 Full file preview</summary>
```Python
{!> ../../docs_src/separate_openapi_schemas/tutorial001.py!}
```
</details>
////
### Model for Input ### Model for Input
If you use this model as an input like here: If you use this model as an input like here:
//// tab | Python 3.10+ {* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:15] hl[14] *}
```Python hl_lines="14"
{!> ../../docs_src/separate_openapi_schemas/tutorial001_py310.py[ln:1-15]!}
# Code below omitted 👇
```
<details>
<summary>👀 Full file preview</summary>
```Python
{!> ../../docs_src/separate_openapi_schemas/tutorial001_py310.py!}
```
</details>
////
//// tab | Python 3.9+
```Python hl_lines="16"
{!> ../../docs_src/separate_openapi_schemas/tutorial001_py39.py[ln:1-17]!}
# Code below omitted 👇
```
<details>
<summary>👀 Full file preview</summary>
```Python
{!> ../../docs_src/separate_openapi_schemas/tutorial001_py39.py!}
```
</details>
////
//// tab | Python 3.8+
```Python hl_lines="16"
{!> ../../docs_src/separate_openapi_schemas/tutorial001.py[ln:1-17]!}
# Code below omitted 👇
```
<details>
<summary>👀 Full file preview</summary>
```Python
{!> ../../docs_src/separate_openapi_schemas/tutorial001.py!}
```
</details>
////
...then the `description` field will **not be required**. Because it has a default value of `None`. ...then the `description` field will **not be required**. Because it has a default value of `None`.
@ -142,29 +32,7 @@ You can confirm that in the docs, the `description` field doesn't have a **red a
But if you use the same model as an output, like here: But if you use the same model as an output, like here:
//// tab | Python 3.10+ {* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py hl[19] *}
```Python hl_lines="19"
{!> ../../docs_src/separate_openapi_schemas/tutorial001_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="21"
{!> ../../docs_src/separate_openapi_schemas/tutorial001_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="21"
{!> ../../docs_src/separate_openapi_schemas/tutorial001.py!}
```
////
...then because `description` has a default value, if you **don't return anything** for that field, it will still have that **default value**. ...then because `description` has a default value, if you **don't return anything** for that field, it will still have that **default value**.
@ -223,29 +91,7 @@ Support for `separate_input_output_schemas` was added in FastAPI `0.102.0`. 🤓
/// ///
//// tab | Python 3.10+ {* ../../docs_src/separate_openapi_schemas/tutorial002_py310.py hl[10] *}
```Python hl_lines="10"
{!> ../../docs_src/separate_openapi_schemas/tutorial002_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="12"
{!> ../../docs_src/separate_openapi_schemas/tutorial002_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="12"
{!> ../../docs_src/separate_openapi_schemas/tutorial002.py!}
```
////
### Same Schema for Input and Output Models in Docs ### Same Schema for Input and Output Models in Docs

40
docs/en/docs/python-types.md
View File

@ -22,9 +22,7 @@ If you are a Python expert, and you already know everything about type hints, sk
Let's start with a simple example: Let's start with a simple example:
```Python {* ../../docs_src/python_types/tutorial001.py *}
{!../../docs_src/python_types/tutorial001.py!}
```
Calling this program outputs: Calling this program outputs:
@ -38,9 +36,7 @@ The function does the following:
* Converts the first letter of each one to upper case with `title()`. * Converts the first letter of each one to upper case with `title()`.
* <abbr title="Puts them together, as one. With the contents of one after the other.">Concatenates</abbr> them with a space in the middle. * <abbr title="Puts them together, as one. With the contents of one after the other.">Concatenates</abbr> them with a space in the middle.
```Python hl_lines="2" {* ../../docs_src/python_types/tutorial001.py hl[2] *}
{!../../docs_src/python_types/tutorial001.py!}
```
### Edit it ### Edit it
@ -82,9 +78,7 @@ That's it.
Those are the "type hints": Those are the "type hints":
```Python hl_lines="1" {* ../../docs_src/python_types/tutorial002.py hl[1] *}
{!../../docs_src/python_types/tutorial002.py!}
```
That is not the same as declaring default values like would be with: That is not the same as declaring default values like would be with:
@ -112,9 +106,7 @@ With that, you can scroll, seeing the options, until you find the one that "ring
Check this function, it already has type hints: Check this function, it already has type hints:
```Python hl_lines="1" {* ../../docs_src/python_types/tutorial003.py hl[1] *}
{!../../docs_src/python_types/tutorial003.py!}
```
Because the editor knows the types of the variables, you don't only get completion, you also get error checks: Because the editor knows the types of the variables, you don't only get completion, you also get error checks:
@ -122,9 +114,7 @@ Because the editor knows the types of the variables, you don't only get completi
Now you know that you have to fix it, convert `age` to a string with `str(age)`: Now you know that you have to fix it, convert `age` to a string with `str(age)`:
```Python hl_lines="2" {* ../../docs_src/python_types/tutorial004.py hl[2] *}
{!../../docs_src/python_types/tutorial004.py!}
```
## Declaring types ## Declaring types
@ -143,9 +133,7 @@ You can use, for example:
* `bool` * `bool`
* `bytes` * `bytes`
```Python hl_lines="1" {* ../../docs_src/python_types/tutorial005.py hl[1] *}
{!../../docs_src/python_types/tutorial005.py!}
```
### Generic types with type parameters ### Generic types with type parameters
@ -369,9 +357,7 @@ It's just about the words and names. But those words can affect how you and your
As an example, let's take this function: As an example, let's take this function:
```Python hl_lines="1 4" {* ../../docs_src/python_types/tutorial009c.py hl[1,4] *}
{!../../docs_src/python_types/tutorial009c.py!}
```
The parameter `name` is defined as `Optional[str]`, but it is **not optional**, you cannot call the function without the parameter: The parameter `name` is defined as `Optional[str]`, but it is **not optional**, you cannot call the function without the parameter:
@ -387,9 +373,7 @@ say_hi(name=None) # This works, None is valid 🎉
The good news is, once you are on Python 3.10 you won't have to worry about that, as you will be able to simply use `|` to define unions of types: The good news is, once you are on Python 3.10 you won't have to worry about that, as you will be able to simply use `|` to define unions of types:
```Python hl_lines="1 4" {* ../../docs_src/python_types/tutorial009c_py310.py hl[1,4] *}
{!../../docs_src/python_types/tutorial009c_py310.py!}
```
And then you won't have to worry about names like `Optional` and `Union`. 😎 And then you won't have to worry about names like `Optional` and `Union`. 😎
@ -451,15 +435,11 @@ You can also declare a class as the type of a variable.
Let's say you have a class `Person`, with a name: Let's say you have a class `Person`, with a name:
```Python hl_lines="1-3" {* ../../docs_src/python_types/tutorial010.py hl[1:3] *}
{!../../docs_src/python_types/tutorial010.py!}
```
Then you can declare a variable to be of type `Person`: Then you can declare a variable to be of type `Person`:
```Python hl_lines="6" {* ../../docs_src/python_types/tutorial010.py hl[6] *}
{!../../docs_src/python_types/tutorial010.py!}
```
And then, again, you get all the editor support: And then, again, you get all the editor support:

7
docs/en/docs/release-notes.md
View File

@ -9,6 +9,12 @@ hide:
### Docs ### Docs
* 📝 Update includes for `docs/en/docs/how-to/configure-swagger-ui.md`. PR [#12556](https://github.com/fastapi/fastapi/pull/12556) by [@tiangolo](https://github.com/tiangolo).
* 📝 Update includes for `docs/en/docs/how-to/separate-openapi-schemas.md`. PR [#12555](https://github.com/fastapi/fastapi/pull/12555) by [@tiangolo](https://github.com/tiangolo).
* 📝 Update includes for `docs/en/docs/advanced/security/http-basic-auth.md`. PR [#12553](https://github.com/fastapi/fastapi/pull/12553) by [@tiangolo](https://github.com/tiangolo).
* 📝 Update includes in `docs/en/docs/tutorial/first-steps.md`. PR [#12552](https://github.com/fastapi/fastapi/pull/12552) by [@tiangolo](https://github.com/tiangolo).
* 📝 Update includes in `docs/en/docs/python-types.md`. PR [#12551](https://github.com/fastapi/fastapi/pull/12551) by [@tiangolo](https://github.com/tiangolo).
* 📝 Fix link in OAuth2 docs. PR [#12550](https://github.com/fastapi/fastapi/pull/12550) by [@tiangolo](https://github.com/tiangolo).
* 📝 Add External Link: FastAPI do Zero. PR [#12533](https://github.com/fastapi/fastapi/pull/12533) by [@rennerocha](https://github.com/rennerocha). * 📝 Add External Link: FastAPI do Zero. PR [#12533](https://github.com/fastapi/fastapi/pull/12533) by [@rennerocha](https://github.com/rennerocha).
* 📝 Fix minor typos. PR [#12516](https://github.com/fastapi/fastapi/pull/12516) by [@kkirsche](https://github.com/kkirsche). * 📝 Fix minor typos. PR [#12516](https://github.com/fastapi/fastapi/pull/12516) by [@kkirsche](https://github.com/kkirsche).
* 🌐 Fix rendering issue in translations. PR [#12509](https://github.com/fastapi/fastapi/pull/12509) by [@alejsdev](https://github.com/alejsdev). * 🌐 Fix rendering issue in translations. PR [#12509](https://github.com/fastapi/fastapi/pull/12509) by [@alejsdev](https://github.com/alejsdev).
@ -29,6 +35,7 @@ hide:
### Internal ### Internal
* ⬆ Bump cloudflare/wrangler-action from 3.9 to 3.11. PR [#12544](https://github.com/fastapi/fastapi/pull/12544) by [@dependabot[bot]](https://github.com/apps/dependabot).
* 👷 Update GitHub Action to deploy docs previews to handle missing deploy comments. PR [#12527](https://github.com/fastapi/fastapi/pull/12527) by [@tiangolo](https://github.com/tiangolo). * 👷 Update GitHub Action to deploy docs previews to handle missing deploy comments. PR [#12527](https://github.com/fastapi/fastapi/pull/12527) by [@tiangolo](https://github.com/tiangolo).
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#12505](https://github.com/fastapi/fastapi/pull/12505) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci). * ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#12505](https://github.com/fastapi/fastapi/pull/12505) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).

28
docs/en/docs/tutorial/first-steps.md
View File

@ -2,9 +2,7 @@
The simplest FastAPI file could look like this: The simplest FastAPI file could look like this:
```Python {* ../../docs_src/first_steps/tutorial001.py *}
{!../../docs_src/first_steps/tutorial001.py!}
```
Copy that to a file `main.py`. Copy that to a file `main.py`.
@ -157,9 +155,7 @@ You could also use it to generate code automatically, for clients that communica
### Step 1: import `FastAPI` ### Step 1: import `FastAPI`
```Python hl_lines="1" {* ../../docs_src/first_steps/tutorial001.py hl[1] *}
{!../../docs_src/first_steps/tutorial001.py!}
```
`FastAPI` is a Python class that provides all the functionality for your API. `FastAPI` is a Python class that provides all the functionality for your API.
@ -173,9 +169,7 @@ You can use all the <a href="https://www.starlette.io/" class="external-link" ta
### Step 2: create a `FastAPI` "instance" ### Step 2: create a `FastAPI` "instance"
```Python hl_lines="3" {* ../../docs_src/first_steps/tutorial001.py hl[3] *}
{!../../docs_src/first_steps/tutorial001.py!}
```
Here the `app` variable will be an "instance" of the class `FastAPI`. Here the `app` variable will be an "instance" of the class `FastAPI`.
@ -244,9 +238,7 @@ We are going to call them "**operations**" too.
#### Define a *path operation decorator* #### Define a *path operation decorator*
```Python hl_lines="6" {* ../../docs_src/first_steps/tutorial001.py hl[6] *}
{!../../docs_src/first_steps/tutorial001.py!}
```
The `@app.get("/")` tells **FastAPI** that the function right below is in charge of handling requests that go to: The `@app.get("/")` tells **FastAPI** that the function right below is in charge of handling requests that go to:
@ -300,9 +292,7 @@ This is our "**path operation function**":
* **operation**: is `get`. * **operation**: is `get`.
* **function**: is the function below the "decorator" (below `@app.get("/")`). * **function**: is the function below the "decorator" (below `@app.get("/")`).
```Python hl_lines="7" {* ../../docs_src/first_steps/tutorial001.py hl[7] *}
{!../../docs_src/first_steps/tutorial001.py!}
```
This is a Python function. This is a Python function.
@ -314,9 +304,7 @@ In this case, it is an `async` function.
You could also define it as a normal function instead of `async def`: You could also define it as a normal function instead of `async def`:
```Python hl_lines="7" {* ../../docs_src/first_steps/tutorial003.py hl[7] *}
{!../../docs_src/first_steps/tutorial003.py!}
```
/// note /// note
@ -326,9 +314,7 @@ If you don't know the difference, check the [Async: *"In a hurry?"*](../async.md
### Step 5: return the content ### Step 5: return the content
```Python hl_lines="8" {* ../../docs_src/first_steps/tutorial001.py hl[8] *}
{!../../docs_src/first_steps/tutorial001.py!}
```
You can return a `dict`, `list`, singular values as `str`, `int`, etc. You can return a `dict`, `list`, singular values as `str`, `int`, etc.

2
docs/en/docs/tutorial/security/oauth2-jwt.md
View File

@ -72,7 +72,7 @@ It supports many secure hashing algorithms and utilities to work with them.
The recommended algorithm is "Bcrypt". The recommended algorithm is "Bcrypt".
Make sure you create a [virtual environment](../virtual-environments.md){.internal-link target=_blank}, activate it, and then install PassLib with Bcrypt: Make sure you create a [virtual environment](../../virtual-environments.md){.internal-link target=_blank}, activate it, and then install PassLib with Bcrypt:
<div class="termy"> <div class="termy">

Write Preview
Loading…
Cancel
Save