Учебник - Руководство пользователя¶
🌐 Перевод выполнен с помощью ИИ и людей
Этот перевод был сделан ИИ под руководством людей. 🤝
В нем могут быть ошибки из-за неправильного понимания оригинального смысла или неестественности и т. д. 🤖
Вы можете улучшить этот перевод,помогая нам лучше направлять ИИ LLM.
В этом руководстве шаг за шагом показано, как использоватьFastAPI с большинством его функций.
Каждый раздел постепенно основывается на предыдущих, но структура разделяет темы, так что вы можете сразу перейти к нужной теме для решения ваших конкретных задач по API.
Он также создан как справочник на будущее, чтобы вы могли вернуться и посмотреть именно то, что вам нужно.
Запустите код¶
Все блоки кода можно копировать и использовать напрямую (это действительно протестированные файлы Python).
Чтобы запустить любой из примеров, скопируйте код в файлmain.py и запуститеfastapi dev с:
$<fontcolor="#4E9A06">fastapi</font>dev<ustyle="text-decoration-style:solid">main.py</u> <span style="background-color:#009485"><font color="#D3D7CF"> FastAPI </font></span> Starting development server 🚀 Searching for package file structure from directories with <font color="#3465A4">__init__.py</font> files Importing from <font color="#75507B">/home/user/code/</font><font color="#AD7FA8">awesomeapp</font> <span style="background-color:#007166"><font color="#D3D7CF"> module </font></span> 🐍 main.py <span style="background-color:#007166"><font color="#D3D7CF"> code </font></span> Importing the FastAPI app object from the module with the following code: <u style="text-decoration-style:solid">from </u><u style="text-decoration-style:solid"><b>main</b></u><u style="text-decoration-style:solid"> import </u><u style="text-decoration-style:solid"><b>app</b></u> <span style="background-color:#007166"><font color="#D3D7CF"> app </font></span> Using import string: <font color="#3465A4">main:app</font> <span style="background-color:#007166"><font color="#D3D7CF"> server </font></span> Server started at <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000</u></font> <span style="background-color:#007166"><font color="#D3D7CF"> server </font></span> Documentation at <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000/docs</u></font> <span style="background-color:#007166"><font color="#D3D7CF"> tip </font></span> Running in development mode, for production use: <b>fastapi run</b> Logs: <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Will watch for changes in these directories: <b>[</b><font color="#4E9A06">'/home/user/code/awesomeapp'</font><b>]</b> <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Uvicorn running on <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000</u></font> <b>(</b>Press CTRL+C to quit<b>)</b> <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Started reloader process <b>[</b><font color="#34E2E2"><b>383138</b></font><b>]</b> using WatchFiles <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Started server process <b>[</b><font color="#34E2E2"><b>383153</b></font><b>]</b> <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Waiting for application startup. <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Application startup complete.НАСТОЯТЕЛЬНО рекомендуется написать или скопировать код, отредактировать его и запустить локально.
Использование кода в вашем редакторе кода — это то, что действительно показывает преимущества FastAPI: вы увидите, как мало кода нужно написать, все проверки типов, автозавершение и т.д.
Установка FastAPI¶
Первый шаг — установить FastAPI.
Убедитесь, что вы создаливиртуальное окружение, активировали его, и затемустановите FastAPI:
$pipinstall"fastapi[standard]"---> 100%Примечание
При установке с помощьюpip install "fastapi[standard]" добавляются некоторые стандартные необязательные зависимости по умолчанию, включаяfastapi-cloud-cli, который позволяет развернуть приложение наFastAPI Cloud.
Если вы не хотите иметь эти необязательные зависимости, установите простоpip install fastapi.
Если вы хотите установить стандартные зависимости, но безfastapi-cloud-cli, установитеpip install "fastapi[standard-no-fastapi-cloud-cli]".
Продвинутое руководство пользователя¶
Существует такжеПродвинутое руководство пользователя, которое вы сможете прочитать послеУчебник - Руководство пользователя.
Продвинутое руководство пользователя основано на этом, использует те же концепции и обучает некоторым дополнительным функциям.
Но сначала вам следует прочитатьУчебник - Руководство пользователя (то, что вы читаете прямо сейчас).
Оно спроектировано так, что вы можете создать полноценное приложение, используя толькоУчебник - Руководство пользователя, а затем расширить его различными способами, в зависимости от ваших потребностей, используя дополнительные идеи изПродвинутого руководства пользователя.