Request Data

Data enters your application from the client in various forms: URL parameters, query strings, headers, and body payloads. BustAPI provides multiple ways to access this data.

The request Proxy

For direct, imperative access to request data, use the global request object. This object is a thread-safe proxy that always points to the incoming request for the current context.

Query Strings

To access URL parameters like ?key=value, use the args attribute:

from bustapi import request

@app.route("/search")
def search():
    search_query = request.args.get("q", "")
    return f"Searching for {search_query}"

Form Data

To access form data from POST requests, use the form attribute:

@app.route("/login", methods=["POST"])
def login():
    username = request.form.get("username")
    password = request.form.get("password")
    return "Logged in"

JSON Data

For API endpoints receiving JSON, use get_json():

@app.post("/api/data")
def api_data():
    data = request.get_json()
    # data is now a standard Python dictionary
    return data

Type-Safe Injection (Recommended)

While the request object is useful, the "modern" way to handle data in BustAPI is via function parameter injection. This provides auto-validation and clearer function signatures.

Query Injection

Use the Query marker to declare query parameters.

from bustapi import Query

@app.get("/items")
def items(limit: int = Query(10), offset: int = Query(0)):
    # limit and offset are automatically converted to int
    return f"Showing items {offset} to {offset + limit}"

Body Injection

Use the Body marker to declare a JSON body requirement.

from bustapi import Body

@app.post("/items")
def create_item(payload: dict = Body(...)):
    # payload is guaranteed to be a dict
    # '...' means it is required
    return payload