happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

📝 Update includes in `docs/en/docs/advanced/generate-clients.md` (#12642)

This commit is contained in:
AyushSinghal1794 2024-11-09 22:22:15 +05:30 committed by GitHub
parent d9119528ea
commit ac4956d3a3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/en/docs/advanced/generate-clients.md
View File

@ -32,21 +32,7 @@ There are also several other companies offering similar services that you can se
Let's start with a simple FastAPI application: Let's start with a simple FastAPI application:
//// tab | Python 3.9+ {* ../../docs_src/generate_clients/tutorial001_py39.py hl[7:9,12:13,16:17,21] *}
```Python hl_lines="7-9 12-13 16-17 21"
{!> ../../docs_src/generate_clients/tutorial001_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="9-11 14-15 18 19 23"
{!> ../../docs_src/generate_clients/tutorial001.py!}
```
////
Notice that the *path operations* define the models they use for request payload and response payload, using the models `Item` and `ResponseMessage`. Notice that the *path operations* define the models they use for request payload and response payload, using the models `Item` and `ResponseMessage`.
@ -151,21 +137,7 @@ In many cases your FastAPI app will be bigger, and you will probably use tags to
For example, you could have a section for **items** and another section for **users**, and they could be separated by tags: For example, you could have a section for **items** and another section for **users**, and they could be separated by tags:
//// tab | Python 3.9+ {* ../../docs_src/generate_clients/tutorial002_py39.py hl[21,26,34] *}
```Python hl_lines="21 26 34"
{!> ../../docs_src/generate_clients/tutorial002_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="23 28 36"
{!> ../../docs_src/generate_clients/tutorial002.py!}
```
////
### Generate a TypeScript Client with Tags ### Generate a TypeScript Client with Tags
@ -212,21 +184,7 @@ For example, here it is using the first tag (you will probably have only one tag
You can then pass that custom function to **FastAPI** as the `generate_unique_id_function` parameter: You can then pass that custom function to **FastAPI** as the `generate_unique_id_function` parameter:
//// tab | Python 3.9+ {* ../../docs_src/generate_clients/tutorial003_py39.py hl[6:7,10] *}
```Python hl_lines="6-7 10"
{!> ../../docs_src/generate_clients/tutorial003_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="8-9 12"
{!> ../../docs_src/generate_clients/tutorial003.py!}
```
////
### Generate a TypeScript Client with Custom Operation IDs ### Generate a TypeScript Client with Custom Operation IDs