Python/FastAPI Tutorial for Visual Studio Code

This sample contains the completed program from the tutorial: FastAPI in Visual Studio Code. Immediate steps are not included.

Run the app using GitHub Codespaces

GitHub Codespaces provides cloud-powered development environments that work how and where you want it to. To learn how to set up a GitHub Codespace for this repository, check the documentation.

Once you open this repository in GitHub Codespaces, you can press F5 to start the debugger and run the application.

Once it's ready, you will see a notification with a button Open in the Browser. Clicking the button will open your application on the browser. You can then add /docs to the end of the URL to access the Swagger UI and interact with the application!

Run the app locally in VS Code

There are diffent ways you can run this app locally in VS Code depending on your operating system. To get started, first clone this project on your machine and then open it in VS Code (File > Open Folder...).

Windows

To run this app locally in VS Code on Windows, you can use either WSL (Windows Subsystem for Linux) or Docker.

Docker Containers

Make sure you have Docker installed
Install the Dev Containers extension
Open the Command Palette in VS Code (View > Command Palette...) and run the "Dev Container: Reopen in Container" command.
Press F5 to debug your application!

WSL

Make sure you have WSL installed
Install the WSL extension for VS Code
Open the Command Palette in VS Code (View > Command Palette...) and run the "WSL: Reopen Folder in WSL" command
Follow the remaining steps for macOS/Linux below.

macOS / Linux

Install the Python extension for VS Code
Run the "Python: Create Environment" command in the Command Palette
Select Venv, the latest available version of Python and then the requirements.txt file to install the dependencies.
Press F5 to run your application!

Contributing

Contributions to the sample are welcome! When submitting changes, also consider submitting matching changes to the tutorial, the source file for which is tutorial-fastapi.md.

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot automatically determines whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

Additional details

This project has adopted the Microsoft Open Source Code of Conduct.
For more information see the Code of Conduct FAQ or
Contact opencode@microsoft.com with any additional questions or comments.

License

microsoft/python-sample-vscode-fastapi-tutorial

About

Resources

License

Code of conduct

Security policy

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 5

Uh oh!

Languages

Packages