tiangolo.fastapi/docs/em/docs/advanced/generate-clients.md

🏗 👩‍💻

FastAPI ⚓️ 🔛 🗄 🔧, 👆 🤚 🏧 🔗 ⏮️ 📚 🧰, 🔌 🏧 🛠️ 🩺 (🚚 🦁 🎚).

1️⃣ 🎯 📈 👈 🚫 🎯 ⭐ 👈 👆 💪 🏗 👩‍💻 (🕣 🤙 📱 ) 👆 🛠️, 📚 🎏 🛠️ 🇪🇸.

🗄 👩‍💻 🚂

📤 📚 🧰 🏗 👩‍💻 ⚪️➡️ 🗄.

⚠ 🧰 🗄 🚂.

🚥 👆 🏗 🕸, 📶 😌 🎛 🗄-📕-🇦🇪.

🏗 📕 🕸 👩‍💻

➡️ ▶️ ⏮️ 🙅 FastAPI 🈸:

//// tab | 🐍 3️⃣.6️⃣ & 🔛

{!> ../../docs_src/generate_clients/tutorial001.py!}

////

//// tab | 🐍 3️⃣.9️⃣ & 🔛

{!> ../../docs_src/generate_clients/tutorial001_py39.py!}

////

👀 👈 ➡ 🛠️ 🔬 🏷 👫 ⚙️ 📨 🚀 & 📨 🚀, ⚙️ 🏷 Item & ResponseMessage.

🛠️ 🩺

🚥 👆 🚶 🛠️ 🩺, 👆 🔜 👀 👈 ⚫️ ✔️ 🔗 📊 📨 📨 & 📨 📨:

👆 💪 👀 👈 🔗 ↩️ 👫 📣 ⏮️ 🏷 📱.

👈 ℹ 💪 📱 🗄 🔗, & ⤴️ 🎦 🛠️ 🩺 (🦁 🎚).

& 👈 🎏 ℹ ⚪️➡️ 🏷 👈 🔌 🗄 ⚫️❔ 💪 ⚙️ 🏗 👩‍💻 📟.

🏗 📕 👩‍💻

🔜 👈 👥 ✔️ 📱 ⏮️ 🏷, 👥 💪 🏗 👩‍💻 📟 🕸.

❎ openapi-ts

👆 💪 ❎ openapi-ts 👆 🕸 📟 ⏮️:

$ npm install @hey-api/openapi-ts --save-dev

---> 100%

🏗 👩‍💻 📟

🏗 👩‍💻 📟 👆 💪 ⚙️ 📋 ⏸ 🈸 openapi-ts 👈 🔜 🔜 ❎.

↩️ ⚫️ ❎ 🇧🇿 🏗, 👆 🎲 🚫🔜 💪 🤙 👈 📋 🔗, ✋️ 👆 🔜 🚮 ⚫️ 🔛 👆 package.json 📁.

⚫️ 💪 👀 💖 👉:

{
  "name": "frontend-app",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "generate-client": "openapi-ts --input http://localhost:8000/openapi.json --output ./src/client --client axios"
  },
  "author": "",
  "license": "",
  "devDependencies": {
    "@hey-api/openapi-ts": "^0.27.38",
    "typescript": "^4.6.2"
  }
}

⏮️ ✔️ 👈 ☕ generate-client ✍ 📤, 👆 💪 🏃 ⚫️ ⏮️:

$ npm run generate-client

[email protected] generate-client /home/user/code/frontend-app
> openapi-ts --input http://localhost:8000/openapi.json --output ./src/client --client axios

👈 📋 🔜 🏗 📟 ./src/client & 🔜 ⚙️ axios (🕸 🇺🇸🔍 🗃) 🔘.

🔄 👅 👩‍💻 📟

🔜 👆 💪 🗄 & ⚙️ 👩‍💻 📟, ⚫️ 💪 👀 💖 👉, 👀 👈 👆 🤚 ✍ 👩‍🔬:

👆 🔜 🤚 ✍ 🚀 📨:

/// tip

👀 ✍ name & price, 👈 🔬 FastAPI 🈸, Item 🏷.

///

👆 🔜 ✔️ ⏸ ❌ 📊 👈 👆 📨:

📨 🎚 🔜 ✔️ ✍:

FastAPI 📱 ⏮️ 🔖

📚 💼 👆 FastAPI 📱 🔜 🦏, & 👆 🔜 🎲 ⚙️ 🔖 🎏 🎏 👪 ➡ 🛠️.

🖼, 👆 💪 ✔️ 📄 🏬 & ➕1️⃣ 📄 👩‍💻, & 👫 💪 👽 🔖:

//// tab | 🐍 3️⃣.6️⃣ & 🔛

{!> ../../docs_src/generate_clients/tutorial002.py!}

////

//// tab | 🐍 3️⃣.9️⃣ & 🔛

{!> ../../docs_src/generate_clients/tutorial002_py39.py!}

////

🏗 📕 👩‍💻 ⏮️ 🔖

🚥 👆 🏗 👩‍💻 FastAPI 📱 ⚙️ 🔖, ⚫️ 🔜 🛎 🎏 👩‍💻 📟 ⚓️ 🔛 🔖.

👉 🌌 👆 🔜 💪 ✔️ 👜 ✔ & 👪 ☑ 👩‍💻 📟:

👉 💼 👆 ✔️:

• ItemsService
• UsersService

👩‍💻 👩‍🔬 📛

▶️️ 🔜 🏗 👩‍🔬 📛 💖 createItemItemsPost 🚫 👀 📶 🧹:

ItemsService.createItemItemsPost({name: "Plumbus", price: 5})

...👈 ↩️ 👩‍💻 🚂 ⚙️ 🗄 🔗 🛠️ 🆔 🔠 ➡ 🛠️.

🗄 🚚 👈 🔠 🛠️ 🆔 😍 🤭 🌐 ➡ 🛠️, FastAPI ⚙️ 🔢 📛, ➡, & 🇺🇸🔍 👩‍🔬/🛠️ 🏗 👈 🛠️ 🆔, ↩️ 👈 🌌 ⚫️ 💪 ⚒ 💭 👈 🛠️ 🆔 😍.

✋️ 👤 🔜 🎦 👆 ❔ 📉 👈 ⏭. 👶

🛃 🛠️ 🆔 & 👍 👩‍🔬 📛

👆 💪 🔀 🌌 👫 🛠️ 🆔 🏗 ⚒ 👫 🙅 & ✔️ 🙅 👩‍🔬 📛 👩‍💻.

👉 💼 👆 🔜 ✔️ 🚚 👈 🔠 🛠️ 🆔 😍 🎏 🌌.

🖼, 👆 💪 ⚒ 💭 👈 🔠 ➡ 🛠️ ✔️ 🔖, & ⤴️ 🏗 🛠️ 🆔 ⚓️ 🔛 🔖 & ➡ 🛠️ 📛 (🔢 📛).

🛃 🏗 😍 🆔 🔢

FastAPI ⚙️ 😍 🆔 🔠 ➡ 🛠️, ⚫️ ⚙️ 🛠️ 🆔 & 📛 🙆 💪 🛃 🏷, 📨 ⚖️ 📨.

👆 💪 🛃 👈 🔢. ⚫️ ✊ APIRoute & 🔢 🎻.

🖼, 📥 ⚫️ ⚙️ 🥇 🔖 (👆 🔜 🎲 ✔️ 🕴 1️⃣ 🔖) & ➡ 🛠️ 📛 (🔢 📛).

👆 💪 ⤴️ 🚶‍♀️ 👈 🛃 🔢 FastAPI generate_unique_id_function 🔢:

//// tab | 🐍 3️⃣.6️⃣ & 🔛

{!> ../../docs_src/generate_clients/tutorial003.py!}

////

//// tab | 🐍 3️⃣.9️⃣ & 🔛

{!> ../../docs_src/generate_clients/tutorial003_py39.py!}

////

🏗 📕 👩‍💻 ⏮️ 🛃 🛠️ 🆔

🔜 🚥 👆 🏗 👩‍💻 🔄, 👆 🔜 👀 👈 ⚫️ ✔️ 📉 👩‍🔬 📛:

👆 👀, 👩‍🔬 📛 🔜 ✔️ 🔖 & ⤴️ 🔢 📛, 🔜 👫 🚫 🔌 ℹ ⚪️➡️ 📛 ➡ & 🇺🇸🔍 🛠️.

🗜 🗄 🔧 👩‍💻 🚂

🏗 📟 ✔️ ❎ ℹ.

👥 ⏪ 💭 👈 👉 👩‍🔬 🔗 🏬 ↩️ 👈 🔤 ItemsService (✊ ⚪️➡️ 🔖), ✋️ 👥 ✔️ 📛 🔡 👩‍🔬 📛 💁‍♂️. 👶

👥 🔜 🎲 💚 🚧 ⚫️ 🗄 🏢, 👈 🔜 🚚 👈 🛠️ 🆔 😍.

✋️ 🏗 👩‍💻 👥 💪 🔀 🗄 🛠️ 🆔 ▶️️ ⏭ 🏭 👩‍💻, ⚒ 👈 👩‍🔬 📛 👌 & 🧹.

👥 💪 ⏬ 🗄 🎻 📁 openapi.json & ⤴️ 👥 💪 ❎ 👈 🔡 🔖 ⏮️ ✍ 💖 👉:

{!../../docs_src/generate_clients/tutorial004.py!}

⏮️ 👈, 🛠️ 🆔 🔜 📁 ⚪️➡️ 👜 💖 items-get_items get_items, 👈 🌌 👩‍💻 🚂 💪 🏗 🙅 👩‍🔬 📛.

🏗 📕 👩‍💻 ⏮️ 🗜 🗄

🔜 🔚 🏁 📁 openapi.json, 👆 🔜 🔀 package.json ⚙️ 👈 🇧🇿 📁, 🖼:

{
  "name": "frontend-app",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "generate-client": "openapi-ts --input ./openapi.json --output ./src/client --client axios"
  },
  "author": "",
  "license": "",
  "devDependencies": {
    "@hey-api/openapi-ts": "^0.27.38",
    "typescript": "^4.6.2"
  }
}

⏮️ 🏭 🆕 👩‍💻, 👆 🔜 🔜 ✔️ 🧹 👩‍🔬 📛, ⏮️ 🌐 ✍, ⏸ ❌, ♒️:

💰

🕐❔ ⚙️ 🔁 🏗 👩‍💻 👆 🔜 ✍ :

• 👩‍🔬.
• 📨 🚀 💪, 🔢 🔢, ♒️.
• 📨 🚀.

👆 🔜 ✔️ ⏸ ❌ 🌐.

& 🕐❔ 👆 ℹ 👩‍💻 📟, & ♻ 🕸, ⚫️ 🔜 ✔️ 🙆 🆕 ➡ 🛠️ 💪 👩‍🔬, 🗝 🕐 ❎, & 🙆 🎏 🔀 🔜 🎨 🔛 🏗 📟. 👶

👉 ⛓ 👈 🚥 🕳 🔀 ⚫️ 🔜 🎨 🔛 👩‍💻 📟 🔁. & 🚥 👆 🏗 👩‍💻 ⚫️ 🔜 ❌ 👅 🚥 👆 ✔️ 🙆 🔖 📊 ⚙️.

, 👆 🔜 🔍 📚 ❌ 📶 ⏪ 🛠️ 🛵 ↩️ ✔️ ⌛ ❌ 🎦 🆙 👆 🏁 👩‍💻 🏭 & ⤴️ 🔄 ℹ 🌐❔ ⚠. 👶