BizAPI 0.1.1

A Lightweight Web Framework for Python

Source Code and Information about BizAPI

Contents

• Installation
• Quick Start
• Routing
  • Function-Based
  • Parameterized
  • Allowed Methods
  • Class-Based
  • Simple Router
• Templates
• Exception Handler
• Custom Responses
• Middleware

Installation

To install BizAPI, use the following command:

pip install BizAPI

Quick Start

Create a simple application using BizAPI:

from bizapi import BizAPI
from bizapi.types import Request, Response

app = BizAPI()


@app.route('/')
def home(request: Request, response: Response):
    response.text = 'This is the home page'

Run the application using Gunicorn:

gunicorn main:app

Routing

Function-Based Routing

@app.route('/')
def index(request: Request, response: Response):
    response.text = "Hello World!"

Parameterized Routing

@app.route('/say-hello/{name}')
def sayhello(request: Request, response: Response, name: str):
    response.text = f"Assalawma áleykum {name}"

Allowed Methods

@app.route('/article', methods=['POST'])
def create_article(request: Request, response: Response):
    # Create a new article
    pass


@app.route('/article', methods=['GET'])
def get_article(request: Request, response: Response):
    # Get an article
    pass

You can also use the method-specific decorators:

@app.post('/article')
def create_product(request: Request, response: Response):
    # Create a new article
    pass


@app.get('/article')
def get_product(request: Request, response: Response):
    # Get an article
    pass

Class-Based Routing

@app.route('/article')
class Article:
    def get(request: Request, response: Response):
        # Get an article
        pass
    
    def post(request: Request, response: Response):
        # Create a new article
        pass

Simple Router

def create_article(request: Request, response: Response):
    response.text = "A new article has been created"


app.register_route('/article', create_article, ['POST'])

Templates

from bizapi import render_template

@app.route('/hello')
def hello_page(request: Request, response: Response):
    response.html = render_template('hello.html', name="John")



# Second way
@app.route('/say-hello', methods=['GET'])
def home_page(request: Request, response: Response):
    response.html = render_template('hello.html', {
        'title': 'Say Hello!',
        'name': 'John'
    })

templates/hello.txt

<html>
    <head><title>Hello</title></head>
    <body><p>Hello, {{name}}</p></body>
</html>

Exception Handler

Add a custom exception handler to manage errors:

def on_exception(request: Request, response: Response, exc: Exception):
    response.text = str(exc)


app.add_exception_handler(on_exception)

Custom Response

BizAPI allows returning different types of responses:

@app.route('/json')
def json(request: Request, response: Response):
    response.json = {'message': 'Hello, World'}

@app.route('/text')
def text(request: Request, response: Response):
    response.text = "Hello World"

@app.route('/html')
def html(request: Request, response: Response):
    response.html = "<h1>Hello, World</h1>"

Middleware

You can add middleware to process requests and responses:

from bizapi.middleware import Middleware

class CustomMiddleware(Middleware):
    def request(self, request: Request):
        print(f"Request received: {request.path}")

    def response(self, request: Request, response: Response):
        print(f"Response sent for: {request.path}")

app.add_middleware(CustomMiddleware)

License
This project is licensed under the MIT License.