FastAPI Service

Project overview

This project is objected to simulate API server for website. In this project, we will be using FastAPI. It's an API based on OpenAPI written in Python and showing the UI and Swagger UI. FastAPI is developed to ensure fast and easy-to-code API.

---

Objective

• Implement FastAPI in a server
• Write a bash script to automate the operation using system service
• Allow other machines to access the server

---

How to operate

1. Extract the files from the provided zip file or clone from GitHub
2. Add execution permission to the script config.sh

chmod +x config.sh

3. Run the script

./config.sh

4. To access the web, click on the link in the terminal
5. To see the UI, add docs at the end of the link
6. To access from another machine, get the server's IP adress (must be on the same LAN), then input http://{ip}:{port}/docs

---

Note for project demo in class

1. Before opening your virtual box machine, got to setting, Network, Adapter 1 (the tab), then in the Attached to field, click on the drop down menu. Choose Bridged Adapter.
2. Now, run your machine
3. Open terminal, make sure it's connected to LAN (your WiFi), check for your VM IP address

sudo apt install net-tools
ifconfig

In the output, note the IP address (wlo1, the number that comes after inet)

3. On your host OS (windows or anything that run natively on your computer), open vscode
4. In the extension marketplace, install Remote SSH
5. Once done, open Command Palette (ctrl + shift + P), on the field, search Remote-SSH: Add new host
6. Type: ssh username@IP_address
7. Click Enter, then follow the prompt
8. When it open config file, double check your username and IP address
9. Now, open the Command Palette again, search Remote-SSH: connect to host
10. In the drop down menu, choose your VM (usually it displays IP address)
11. Once you got in, clione the fast_api repo:

sudo apt install git
git clone https://github.com/c-lydia/fast_api

11. Once done, open Folder, in the popped up field, choose fast_api, then click OK
12. open src directory
13. Now, go to terminal, open that folder

cd ~/fast_api/src
pwd

14. Copy the output of pwd, then open the config.sh file in the vscode editor. Paste the output you just copied into WORKING_DIR (a variable)
15. Save the file, then go to terminal, now, run the code

chmod +x config.sh
./config.sh

16. Follow the prompt if it ask you to authenticate
17. Once the server is up, open your browser in the VM, then in the search bar type: localhost:8000/docs, this will open the API in the browser
18. On another machine or your native computer, open the browser, then search: VM_IP:8000/docs