Build your own API

What is an API?

Explain API’s like Im 5.

An API is like a magic button that different programs can push to talk to each other and share information. Imagine you have a toy box with different toy cars inside, and you have a friend who has a toy box with toy houses. An API is like a secret knock that you can use to open the lid of your toy box and show your friend the cars inside, and your friend can use the same knock to open their toy box and show you the houses. In this way, the toy cars and houses can play together, just like how different programs can share information and work together with the help of an API.

Practical Example

For example, a weather website might have an API that allows a developer to retrieve current weather data for a specific location in a format that can be easily integrated into their own website or application.

Rest API Architecture

Understanding Json Data

What is json?

JSON is a text-based format for representing data, which is commonly used for exchanging data between different systems, especially in web applications. JSON is based on a subset of the JavaScript Programming Language and it is used to represent simple data structures and objects, and arrays. JSON is a standard format and it's supported by almost all the programming languages.

Is it a like a python dictionary?

A Python dictionary, on the other hand, is a built-in data structure in the Python programming language. It is a collection of key-value pairs, where each key is unique and the value can be of any type. Like JSON, Python dictionaries are also used to store and organize data in a structured way.

Python Dictionary vs Json

JSON (JavaScript Object Notation) and Python dictionaries are similar in that they are both used to store and organize data in a structured format. However, they are not exactly the same thing.

It's important to note that JSON data can be easily converted to and from Python dictionaries, using the built-in json module in python. This allows to easily exchange data between systems that use different formats.

Therefore, JSON is a format for storing and exchanging data and Python dictionaries is a data structure for storing data in Python. They share similarities but are not exactly the same thing.

Lets Code!

Install dependancies

pip3 install fastapi
pip3 install uvicorn

Fast API Docs

FastAPI

Directory and Project Structure

fast-api-python
├── README.md
└── example1.py

Create example1.py

from fastapi import FastAPI

app = FastAPI()                 # Creates api object 

@app.get("/")                   #This the root of an "endpoint" 
def home():
    return {"Data": "Test"}

Informational Block

# endpoints
/
/about

/hello
/get-item
localhost/hello

# Methods
GET     # Returns information
POST    # Sending information or creating data
PUT     # Update something thats existing in the data base 
DELETE  # Deleting info

Start web server to run locally

example1 in the name of our .py file above and app is the FastAPI object in our code

uvicorn example1:app --reload

Now go to the local host and youll see our data from our python script

http://127.0.0.1:8000/

Documentation

FastAPI automatically creates an api documentation for how to interact with it

http://127.0.0.1:8000/docs

Create another endpoint

Edit main.py and save it

from fastapi import FastAPI

app = FastAPI()                 # Creates api object 

@app.get("/")                   #This the root of an "endpoint" 
def home():
    return {"Data": "Test"}

@app.get("/about")              #This is another directory of an endpoint
def about():
    return {"Data", "About_endpoint_data"}

unicorn is still running our server in the terminal. Reload the web page and youll see the data.

http://127.0.0.1:8000/about

Interacting with our API

create example2.py

from fastapi import FastAPI

app = FastAPI()                 # Creates api object 

inventory = {
        1:  {
            "name": "Milk",
            "price": 3.99,
            "brand": "fairlife"
        }
    
}

@app.get("/get-item/{item_id}")
def get_item(item_id: int):                 # Uses the int forces the parameter being passed to be an integer otherwise it wont work
    return inventory[item_id]

Trust but Verify

Make sure you saved the code

Interact with the code we just wrote

http://127.0.0.1:8000/get-item/1

Try typing a letter and see the error you get

http://127.0.0.1:8000/get-item/f

try going to the number 2 in our inventory list - see the error because we have created it yet

http://127.0.0.1:8000/get-item/2

Adding PATH parameters

edit example2.py

from fastapi import FastAPI, Path

app = FastAPI()                 # Creates api object 

inventory = {
        1:  {
            "name": "Milk",
            "price": 3.99,
            "brand": "fairlife"
        }
    
}

@app.get("/get-item/{item_id}")
def get_item(item_id: int = Path(None, gt=0, lt=2, description="The ID of the item you would like to view")) :                 # Uses the int forces the parameter being passed to be an integer otherwise it wont work 
    return inventory[item_id]

Description above gets added to the docs here.

Constraints added

greater than 1 and less than 2

gt=0, lt=2

Trust but Verify

Make sure you saved the code

Interact with the code we just wrote

http://127.0.0.1:8000/get-item/1

Try typing any number besides 1. The error message is more helpful now.

http://127.0.0.1:8000/get-item/0
http://127.0.0.1:8000/get-item/2

Adding Query Parameters

examples of query parameters

"facebook.com/home?redirect="
"facebook.com/home?key="
"facebook.com/home?redirect=/drew&msg=fail"

See how they all have the syntax

?<variable_name>=

Having our endpoint accept query parameters

from fastapi import FastAPI, Path

app = FastAPI()                 # Creates api object 

inventory = {
        1:  {
            "name": "Milk",
            "price": 3.99,
            "brand": "fairlife"
        }
    
}

@app.get("/get-item/{item_id}")
def get_item(item_id: int = Path(None, gt=0, lt=2, description="The ID of the item you would like to view")) :                 # Uses the int forces the parameter being passed to be an integer otherwise it wont work 
    return inventory[item_id]

@app.get("/get-by-name")
def get_item(name: str):
    for item_id in inventory:
        if inventory[item_id]["name"] == name:
            return inventory[item_id]
    return {"Data": "Not FOund"}

How to call the new endpoint we made

http://127.0.0.1:8000/get-by-name?name=Milk
http://127.0.0.1:8000/get-by-name?name=drew
http://127.0.0.1:8000/get-by-name

Request Body & Post method

Adding information to a database

edit and save example2.py

from fastapi import FastAPI, Path
from typing import Optional
from pydantic import BaseModel

app = FastAPI()                 # Creates api object 

inventory = {
        1:  {
            "name": "Milk",
            "price": 3.99,
            "brand": "fairlife"
        }
    
}

class Item(BaseModel):
    name: str
    price: float
    brand: Optional[str] = None

@app.get("/get-item/{item_id}")
def get_item(item_id: int = Path(None, gt=0, description="The ID of the item you would like to view")) :                 # Uses the int forces the parameter being passed to be an integer otherwise it wont work 
    return inventory[item_id]

@app.get("/get-by-name")
def get_item(name: str = None):
    for item_id in inventory:
        if inventory[item_id]["name"] == name:
            return inventory[item_id]
    return {"Data": "Not FOund"}

@app.post("/create-item/{item_id}")
def create_item(item_id: int, item: Item):
    if item_id in inventory:
        return {"Error": "Item ID already exists"}
    inventory[item_id] = {"name": item.name, "brand": item.brand, "price": item.price}
    return inventory[item_id]

Trust but Verify

Add item ID below and add info for name and price

Hit Execute and added Items are stored in memory. The json code in the picture should have the comma on the last KEY=VALUE pair

Now add ID 2 and you should GET the data we previously POSTED

Refactor code

from fastapi import FastAPI, Path
from typing import Optional
from pydantic import BaseModel

app = FastAPI()                 # Creates api object 

inventory = {}

class Item(BaseModel):
    name: str
    price: float
    brand: Optional[str] = None

@app.get("/get-item/{item_id}")
def get_item(item_id: int = Path(None, gt=0, description="The ID of the item you would like to view")) :                 # Uses the int forces the parameter being passed to be an integer otherwise it wont work 
    return inventory[item_id]

@app.get("/get-by-name")
def get_item(name: str = None):
    for item_id in inventory:
        if inventory[item_id].name == name:
            return inventory[item_id]
    return {"Data": "Not FOund"}

@app.post("/create-item/{item_id}")
def create_item(item_id: int, item: Item):
    if item_id in inventory:
        return {"Error": "Item ID already exists"}
    inventory[item_id] = item
    return inventory[item_id]

We now have an empty inventory list

Lets go to the docs

http://127.0.0.1:8000/docs

POST /create-items/{item_id}

{
  "name": "milk",
  "price": 5.99,
  "brand": "fairlife"
}

{
  "name": "milk",
  "price": 5.99
}

GET/get-by-name

Enter eggs or milk

GET/get-item/{item_id}

Enter 1 and 2 see how you retrieved the info you just posted

PUT Request

put updates items

edit example2.py

from fastapi import FastAPI, Path
from typing import Optional
from pydantic import BaseModel

app = FastAPI()                 # Creates api object 

inventory = {}

class Item(BaseModel):
    name: str
    price: float
    brand: Optional[str] = None

class UpdateItem(BaseModel):
    name: Optional[str] = None
    price: Optional[float] = None
    brand: Optional[str] = None

    

@app.get("/get-item/{item_id}")
def get_item(item_id: int = Path(None, gt=0, description="The ID of the item you would like to view")) :                 # Uses the int forces the parameter being passed to be an integer otherwise it wont work 
    return inventory[item_id]

@app.get("/get-by-name")
def get_item(name: str = None):
    for item_id in inventory:
        if inventory[item_id].name == name:
            return inventory[item_id]
    return {"Data": "Not FOund"}

@app.post("/create-item/{item_id}")
def create_item(item_id: int, item: Item):
    if item_id in inventory:
        return {"Error": "Item ID already exists"}
    inventory[item_id] = item
    return inventory[item_id]

@app.put("/update-item/{item_id}")
def update_item(item_id: int, item: UpdateItem):
    if item_id not in inventory:
        return {"Error": "Item ID does not exists."}
    
    if item.name != None:
        inventory[item_id].name = item.name                # Updates the item in our inventory

    if item.price != None:
        inventory[item_id].price = item.price

    if item.brand != None:
        inventory[item_id].brand = item.brand
    
    return inventory[item_id]

Go to docs and add an item

http://127.0.0.1:8000/docs

POST /create-items/{item_id}

{
  "name": "milk",
  "price": 3.99
}

Lets update the added item now

PUT/update-item/{item_id}

{
  "brand": "fairlife"
}

Screenshot 2023-01-18 at 8.22.41 PM Lets update the added item now

PUT/update-item/{item_id}

{
  "name": "eggs"
}

Works the manuel way too

http://127.0.0.1:8000/get-by-name?name=eggs

Delete Method

edit example2.py

from fastapi import FastAPI, Path, Query
from typing import Optional
from pydantic import BaseModel

app = FastAPI()                 # Creates api object 

inventory = {}

class Item(BaseModel):
    name: str
    price: float
    brand: Optional[str] = None

class UpdateItem(BaseModel):
    name: Optional[str] = None
    price: Optional[float] = None
    brand: Optional[str] = None

    

@app.get("/get-item/{item_id}")
def get_item(item_id: int = Path(None, gt=0, description="The ID of the item you would like to view")) :                 # Uses the int forces the parameter being passed to be an integer otherwise it wont work 
    return inventory[item_id]

@app.get("/get-by-name")
def get_item(name: str = None):
    for item_id in inventory:
        if inventory[item_id].name == name:
            return inventory[item_id]
    return {"Data": "Not FOund"}

@app.post("/create-item/{item_id}")
def create_item(item_id: int, item: Item):
    if item_id in inventory:
        return {"Error": "Item ID already exists"}
    inventory[item_id] = item
    return inventory[item_id]

@app.put("/update-item/{item_id}")
def update_item(item_id: int, item: UpdateItem):
    if item_id not in inventory:
        return {"Error": "Item ID does not exists."}
    
    if item.name != None:
        inventory[item_id].name = item.name                # Updates the item in our inventory

    if item.price != None:
        inventory[item_id].price = item.price

    if item.brand != None:
        inventory[item_id].brand = item.brand
    
    return inventory[item_id]

@app.delete("/delete-item")
def delete_item(item_id: int = Query(..., description="The ID of the Item to Delete.", gt=0)):
    if item_id not in inventory:
        return {"Error": "ID Does not exist"}
    
    del inventory[item_id]
    return {"Success": "Item Deleted"}

Go to docs

Create an item

Delete the item

Status codes

from fastapi import FastAPI, Path, Query, HTTPException, status
from typing import Optional
from pydantic import BaseModel

app = FastAPI()                 # Creates api object 

inventory = {}

class Item(BaseModel):
    name: str
    price: float
    brand: Optional[str] = None

class UpdateItem(BaseModel):
    name: Optional[str] = None
    price: Optional[float] = None
    brand: Optional[str] = None

    

@app.get("/get-item/{item_id}")
def get_item(item_id: int = Path(None, gt=0, description="The ID of the item you would like to view")) :                 # Uses the int forces the parameter being passed to be an integer otherwise it wont work 
    return inventory[item_id]

@app.get("/get-by-name")
def get_item(name: str = None):
    for item_id in inventory:
        if inventory[item_id].name == name:
            return inventory[item_id]
    raise HTTPException(status_code=404, detail="Item name not Found")

@app.post("/create-item/{item_id}")
def create_item(item_id: int, item: Item):
    if item_id in inventory:
        raise HTTPException(status_code=400, detail="Item ID already exists")
    inventory[item_id] = item
    return inventory[item_id]

@app.put("/update-item/{item_id}")
def update_item(item_id: int, item: UpdateItem):
    if item_id not in inventory:
        raise HTTPException(status_code=404, detail="Item ID does not exist")
    
    if item.name != None:
        inventory[item_id].name = item.name                # Updates the item in our inventory

    if item.price != None:
        inventory[item_id].price = item.price

    if item.brand != None:
        inventory[item_id].brand = item.brand
    
    return inventory[item_id]

@app.delete("/delete-item")
def delete_item(item_id: int = Query(..., description="The ID of the Item to Delete.", gt=0)):
    if item_id not in inventory:
        raise HTTPException(status_code=404, detail="Item ID does not exist")
    
    del inventory[item_id]
    return {"Success": "Item Deleted"}

Go to the docs and try to find item ID 1 and see the error we now get

Name		Name	Last commit message	Last commit date
Latest commit History 6 Commits
.vscode		.vscode
.gitattributes		.gitattributes
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
example1.py		example1.py
example2.py		example2.py

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Build your own API

What is an API?

Explain API’s like Im 5.

Practical Example

Rest API Architecture

Understanding Json Data

What is json?

Is it a like a python dictionary?

Python Dictionary vs Json

Lets Code!

Install dependancies

Fast API Docs

Create example1.py

Start web server to run locally

Documentation

Create another endpoint

Interacting with our API

Trust but Verify

Adding PATH parameters

Trust but Verify

Adding Query Parameters

examples of query parameters

Having our endpoint accept query parameters

How to call the new endpoint we made

Request Body & Post method

Trust but Verify

Refactor code

PUT Request

Delete Method

Status codes

About

Releases

Packages

Languages

License

PySecNinja/fast-api-python

Folders and files

Latest commit

History

Repository files navigation

Build your own API

What is an API?

Explain API’s like Im 5.

Practical Example

Rest API Architecture

Understanding Json Data

What is json?

Is it a like a python dictionary?

Python Dictionary vs Json

Lets Code!

Install dependancies

Fast API Docs

Create example1.py

Start web server to run locally

Documentation

Create another endpoint

Interacting with our API

Trust but Verify

Adding PATH parameters

Trust but Verify

Adding Query Parameters

examples of query parameters

Having our endpoint accept query parameters

How to call the new endpoint we made

Request Body & Post method

Trust but Verify

Refactor code

PUT Request

Delete Method

Status codes

About

Topics

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages