rewriting enterprise level fast-api

• Setup

  • py -3 -m venv venv

  • . venv/Scripts/activate

  • pip install fastapi

  • pip install uvicorn

  • pip freeze > requirements.txt

• Pytest

  • pip install pytest

  • pip install httpx

• Sqlalchemy

  pip install sqlalchemy

is to have the venv installed and updated readme

adding a file called requirements.txt for dependency management

created main.py file to run endpoint and test to make sure our code runs

swagger ui is included in FastAPI meaning we don't have to write it out from scratch like Flask

testing welcome path op

id column is generated after the other 2 fields are entered primary key makes it easier for us to find the user string(#) will alow how many characters are entered unique ensuring there is one 1 particular value in the database nullable meaning this field is required

this is for when someone is entering data, the data will be bumped against the schema to make sure all fields are present before interacting with the database

orm stands for object realational mapping

this file will have the functions we need to interact with the database this will also have a test data function for testing

this function is for creating our db file in db/local_sqlite

this will drop_all data at first then create the data and add the test data

this code allows us to retrieve all the users in the database also added a function in the users_router.py for users to access

this test is will be testing the first data in our test.db making sure all the values are present

these codes will allow us to get information from a single user by their username

this test will test our post operation in users_router.py and will also preform a get call to check the user information that is created in test.db file

testing different fields to make sure a status_code of 400 is responded to user when not entering all fields for post request

this code will udpate the fields if values are given by the user. We do not want the user to be able to update the username but email and role fields can be updated

this function check if there is a value in the email and role fields, then check to for the username within our database, will check there are values entered by the user in both email and role otherwise the fields will not be updated, also checks if both fields are empty

If email or role values are added or both, this will give a 204 status_code and will commit these changes in our database

testing different areas for put request such as updating both fields or email and role and testing if put request works if we only have 1 field being changed

added more put test by testing the bad scenarios if they body is empty, username not found, and if there is no body in the request

our functino in users_router.py will also include an if statement to check for the user in our database. If user is not found then we will raise a HTTPException of 404

Also added response headers in all of our user functions in users_router.py

is the post request function in users_router.py, we added an additonal check to take the username_request variable from the user and checked to see if it exists in our database already. If so, this will raise an HTTPException of 409 - conflict

like earlier we were checking if the username already exists in the database, we are checking if the email already exists as well and if it does, we raise a 409 Conflict

the first function will create a test user then delete them and will also 'get' user as well to check if user is truly deleted

the second delete function will check if the user does not exist when trying to delete by username