Skip to content

📝Update includes in docs/tutorial/fastapi/read-one.md #1172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

📝Update includes in docs/tutorial/fastapi/read-one.md #1172

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
129135f
Update read-one.md
Nimitha-jagadeesha Oct 27, 2024
91ee94c
Update read-one.md
Nimitha-jagadeesha Oct 27, 2024
2baf1d1
Update read-one.md
Nimitha-jagadeesha Oct 27, 2024
8bbb3c3
Update read-one.md
Nimitha-jagadeesha Oct 27, 2024
02fcedb
Fixed
Nimitha-jagadeesha Oct 27, 2024
82e9efb
Update read-one.md
Nimitha-jagadeesha Oct 27, 2024
cd7ccc8
Merge branch 'main' into feature-docs-syntax
Nimitha-jagadeesha Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
186 changes: 9 additions & 177 deletions docs/tutorial/fastapi/read-one.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,71 +12,13 @@ We want to get the hero based on the `id`, so we will use a **path parameter** `

If you need to refresh how *path parameters* work, including their data validation, check the <a href="https://fastapi.tiangolo.com/tutorial/path-params/" class="external-link" target="_blank">FastAPI docs about Path Parameters</a>.

///
{* ./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py ln[1:2] hl[6] *}

//// tab | Python 3.10+

```Python hl_lines="6"
{!./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py[ln:1-2]!}

# Code here omitted 👈

{!./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py[ln:59-65]!}
```

////

//// tab | Python 3.9+

```Python hl_lines="8"
{!./docs_src/tutorial/fastapi/read_one/tutorial001_py39.py[ln:1-4]!}

# Code here omitted 👈

{!./docs_src/tutorial/fastapi/read_one/tutorial001_py39.py[ln:61-67]!}
```

////

//// tab | Python 3.7+

```Python hl_lines="8"
{!./docs_src/tutorial/fastapi/read_one/tutorial001.py[ln:1-4]!}

# Code here omitted 👈

{!./docs_src/tutorial/fastapi/read_one/tutorial001.py[ln:61-67]!}
```

////
{* ./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py ln[59:65] *}

/// details | 👀 Full file preview

//// tab | Python 3.10+

```Python
{!./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py!}
```

////

//// tab | Python 3.9+

```Python
{!./docs_src/tutorial/fastapi/read_one/tutorial001_py39.py!}
```

////

//// tab | Python 3.7+

```Python
{!./docs_src/tutorial/fastapi/read_one/tutorial001.py!}
```

////

///
{* ./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py *}

For example, to get the hero with ID `2` we would send a `GET` request to:

Expand All @@ -96,139 +38,29 @@ And to use it, we first import `HTTPException` from `fastapi`.

This will let the client know that they probably made a mistake on their side and requested a hero that doesn't exist in the database.

//// tab | Python 3.10+

```Python hl_lines="1 9-11"
{!./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py[ln:1-2]!}
{* ./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py ln[1:2] hl[1,9:11] *}

# Code here omitted 👈

{!./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py[ln:59-65]!}
```

////

//// tab | Python 3.9+

```Python hl_lines="3 11-13"
{!./docs_src/tutorial/fastapi/read_one/tutorial001_py39.py[ln:1-4]!}

# Code here omitted 👈

{!./docs_src/tutorial/fastapi/read_one/tutorial001_py39.py[ln:61-67]!}
```

////

//// tab | Python 3.7+

```Python hl_lines="3 11-13"
{!./docs_src/tutorial/fastapi/read_one/tutorial001.py[ln:1-4]!}

# Code here omitted 👈

{!./docs_src/tutorial/fastapi/read_one/tutorial001.py[ln:61-67]!}
```

////
{* ./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py ln[59:65] hl[1,9:11] *}

/// details | 👀 Full file preview

//// tab | Python 3.10+

```Python
{!./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py!}
```
{* ./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py *}

////

//// tab | Python 3.9+

```Python
{!./docs_src/tutorial/fastapi/read_one/tutorial001_py39.py!}
```

////

//// tab | Python 3.7+

```Python
{!./docs_src/tutorial/fastapi/read_one/tutorial001.py!}
```

////

///

## Return the Hero

Then, if the hero exists, we return it.

And because we are using the `response_model` with `HeroPublic`, it will be validated, documented, etc.

//// tab | Python 3.10+

```Python hl_lines="6 12"
{!./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py[ln:1-2]!}

# Code here omitted 👈

{!./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py[ln:59-65]!}
```

////

//// tab | Python 3.9+

```Python hl_lines="8 14"
{!./docs_src/tutorial/fastapi/read_one/tutorial001_py39.py[ln:1-4]!}

# Code here omitted 👈
{* ./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py ln[1:2] hl[6:12] *}

{!./docs_src/tutorial/fastapi/read_one/tutorial001_py39.py[ln:61-67]!}
```

////

//// tab | Python 3.7+

```Python hl_lines="8 14"
{!./docs_src/tutorial/fastapi/read_one/tutorial001.py[ln:1-4]!}

# Code here omitted 👈

{!./docs_src/tutorial/fastapi/read_one/tutorial001.py[ln:61-67]!}
```

////
{* ./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py ln[59:65] hl[6:12] *}

/// details | 👀 Full file preview

//// tab | Python 3.10+

```Python
{!./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py!}
```

////

//// tab | Python 3.9+

```Python
{!./docs_src/tutorial/fastapi/read_one/tutorial001_py39.py!}
```

////

//// tab | Python 3.7+

```Python
{!./docs_src/tutorial/fastapi/read_one/tutorial001.py!}
```

////

///
{* ./docs_src/tutorial/fastapi/read_one/tutorial001_py310.py *}

## Check the Docs UI

Expand Down
Loading