FastAPI application creation code analysis | HTTP GET request demo code

FastAPI application code

Analyzing GET HTTP request Method:

sample code: It is for GET request code to read data from API endpoint.
book.py

from fastapi import FastAPI   # including package of FastAPI and all dependencies.

app = FastAPI()  #Allows to use all dependencies which come with FastAPI package with the help of variable names app which stand for application.

@app.get("/api-endpoint") #path where we will have the function async def first_api. So it is the route to invoke this function. This will be the path which user need to use in http url to call the method for activity.

async def first_api():
    return {'message': 'Hello Puneet!'}


Note:
async - it is a python function and not needed in FastAPI as FastAPI implement and use it in background.

As we need to create a read method or GET https request method from API endpoint side hence we need to add this async def first_api() method to this GET https request method. 

@app.get("/api-endpoint") - it is a decorator.



How to run our fast API application?

We need to open our terminal and need to run below command to execute the API.

uvicorn books:app --reload

Here books.py is the file which need to be run and app is the variable which will ask FastAPI to run and reload is the command to update the code in browser and run it.



Code for reading the books entries:
@app.get("/listOfBooks")
async def read_all_books():
    return BOOKS

It will return the list of the books which we have in specified URL.

Application run Demo:






Result of the application when giving right URL for result.






Commands to run application from terminal in local system is:
  • uvicorn books:app --reload
  • fastapi run book.py  -> It will run the code in production mode of FastAPI cli.
  • fastapi dev book.py -> It will run the code in developer mode of FastAPI cli.
  • to run fastapi command need to install fastapi[standard]
    • command is : pip install "fastapi[standard]"

Comments

Post a Comment

Popular posts from this blog

Post Request with Pydantic usage (input validator)

Image
Post Request by using Pydantic Pydantic Python library that is used for data modeling, data parsing and has efficient error handling. Pydantics is commonly used as a resource for data validation and how to handle data coming to our FastAPI application. Pydantic implementation mechanism Create a different request model for data validation Field data validation on each variable/element BaseModel is the Pydantics BaseModel class which will provide facility to validate data. Field is the keyword to do it. As it will help to provide constraints for data validation. sample class BookRequest(BaseModel):     id: int = Field(gt=0)     title: str = Field(min_length=3)     author: str = Field(min_length=1)     description: str = Field(min_length=1, max_length=100)     rating: int = Field(gt=0, lt=5) Book Request and Book Conversion We will convert the Pydantic Request into a Book Example for post request method @app.post("/create_book") async def c...
Read more

Code Scalability and Routing

Image
 Creating Authentication file As we need to keep authentication part separate from our main application working so that we will not mess-up with our main application logic and it's security settings and authentication criteria as well as logics. auth.py - Basic authentication code stub. # This file is to define authenticator and authorization for the Todo application. from fastapi import FastAPI , status app = FastAPI () @ app . get ( "/auth" , status_code = status . HTTP_200_OK ) async def get_user ():     return { 'user' : 'authenticated_user' } Create Routers Package Here we want to use both and auth.py and main.py file to run together and to allow routers to run smoothly and want to scale the project code. To make this possible we need to use router facility or FastAPI. Here we are going to have a main file is a route of our application and routes will sit on this main file and will help in performing the tasks on call from main file. To make i...
Read more

CRUD Assignment

Image
 CRUD Assignment 1. Create a new API Endpoint that can fetch all books from a specific author using either Path Parameters or Query Parameters. Code and Result: As async is implemented by FastAPI itself hence ignored it. from fastapi import FastAPI app = FastAPI () BOOKS = [         { "title" : "Book One" , "author" : "Author A" , "category" : "Fiction" },         { "title" : "Book Two" , "author" : "Author B" , "category" : "Non-Fiction" },         { "title" : "Book Three" , "author" : "Author A" , "category" : "Biography" },         { "title" : "Book Four" , "author" : "Author A" , "category" : "Historical" },         { "title" : "Book Five" , "author" : "Author A" , "category" : "Romanc...
Read more