Difference between revisions of "FastAPI"
Adelo Vieira (talk | contribs) (→Environment setup) |
Adelo Vieira (talk | contribs) (→Environment setup) |
||
Line 38: | Line 38: | ||
==Environment setup== | ==Environment setup== | ||
− | * | + | * python3, python3-pip, docker, docker Compose. |
− | * | + | * '''IDE''': The instructor is using Pycharm Professional, which is paid but we can install Pycharm community. On Ubuntu: |
: <syntaxhighlight lang="bash"> | : <syntaxhighlight lang="bash"> | ||
sudo snap install pycharm-community --classic | sudo snap install pycharm-community --classic | ||
</syntaxhighlight> | </syntaxhighlight> | ||
+ | |||
+ | |||
+ | * '''Database''': MongoDB in a Docker container | ||
+ | : '''DB IDE''': | ||
+ | ::* I thinks the instructor is also using PyCharm. | ||
+ | ::* I'll be using the MongoDB for VS Code extension: | ||
+ | ::: https://www.mongodb.com/products/vs-code | ||
+ | ::: https://www.youtube.com/watch?v=MLWlWrRAb4w | ||
+ | ::: https://www.youtube.com/watch?v=1d_G8jr0KJE | ||
+ | |||
* For testing the API we are going to use '''Insomnia''', which is a powerful REST client that allows developers to interact with and test RESTful APIs. It provides a user-friendly interface for making HTTP requests, inspecting responses, and debugging API interactions. The tool is often used for tasks such as sending requests, setting headers, managing authentication, and viewing API documentation. | * For testing the API we are going to use '''Insomnia''', which is a powerful REST client that allows developers to interact with and test RESTful APIs. It provides a user-friendly interface for making HTTP requests, inspecting responses, and debugging API interactions. The tool is often used for tasks such as sending requests, setting headers, managing authentication, and viewing API documentation. |
Revision as of 11:51, 3 June 2023
Build a Modern API with FastAPI and Python: https://www.udemy.com/course/build-a-movie-tracking-api-with-fastapi-and-python/
During this course we will build a Movie Tracking API with Fast API and Python for tracking movies.
- Section 2: Environment Setup
- We will install Pycharm, Docker and Docker-compose and Insomnia. If you already have an environment you can skip this section.
- Note: If you're an university student you can apply for a free licence of Pycharm Professional here: https://www.jetbrains.com/community/education/#students
- Section 3: Docker Basic
- We will learn some basic docker commands that will help us in improving our workflow.
- Section 4: MongoDB Basics
- We will learn very basic MongoDB commands and we'll execute them inside the docker container and in Pycharm Professional.
- Section 5: Web API Project Structure
- In this section we'll learn how to structure the project and we will write some basic endpoints with FastAPI just to make you more familiar with writing endpoints.
- Section 6: Storage Layer
- We talk about CRUD and we'll apply the repository pattern to develop and In-Memory repository and a MongoDB repository in order to use them within our application. We will also test the implementations.
- Section 7: Movie Tracker API
- We will write the actual API for tracking movies using the previous developed components. We'll implement the application's settings module and we'll add pagination to some of the routes. In the end we will write unit tests.
- Section 8: Middleware
- We'll talk about Fast API middleware and how to write your own custom middleware.
- Section 9: Authentication
- We'll talk about implementing Basic Authentication and validating JWT tokens.
- Section 10: Deployment
- We'll containerize the application and we will deploy it on a local microk8s kubernetes cluster. In the end we'll visualise some metrics with Grafana. Having metrics is a good way to observe your applications performance and behaviour and troubleshoot it.
- Resources for this lecture at https://www.udemy.com/course/build-a-movie-tracking-api-with-fastapi-and-python/learn/lecture/35148314?start=1#overview
Environment setup
- python3, python3-pip, docker, docker Compose.
- IDE: The instructor is using Pycharm Professional, which is paid but we can install Pycharm community. On Ubuntu:
sudo snap install pycharm-community --classic
- Database: MongoDB in a Docker container
- DB IDE:
- I thinks the instructor is also using PyCharm.
- I'll be using the MongoDB for VS Code extension:
- For testing the API we are going to use Insomnia, which is a powerful REST client that allows developers to interact with and test RESTful APIs. It provides a user-friendly interface for making HTTP requests, inspecting responses, and debugging API interactions. The tool is often used for tasks such as sending requests, setting headers, managing authentication, and viewing API documentation.
- To install it on Ubuntu:
sudo snap install insomnia