Response Status Code

Control HTTP response status codes in your EVOID services.

Default Behavior

All responses return 200 OK by default:

from evoid.web.route import Service, get

app = Service("api")

@get("/users/{user_id}")
async def get_user(user_id: int) -> dict:
    return {"id": user_id, "name": "Alice"}

@route Style

Use the status parameter to return different codes:

from evoid.web.route import Service, get, post, delete

app = Service("api")

@post("/users", status=201)
async def create_user(name: str, email: str) -> dict:
    return {"status": "created", "name": name, "email": email}

@get("/users/{user_id}")
async def get_user(user_id: int) -> dict:
    if user_id > 100:
        return {"detail": "User not found"}  # still 200
    return {"id": user_id, "name": "Alice"}

@delete("/users/{user_id}", status=204)
async def delete_user(user_id: int) -> dict:
    return {"status": "deleted"}

Returning Errors

To return error status codes, raise an exception in your handler:

from evoid.web.route import Service, get

app = Service("api")

@get("/users/{user_id}")
async def get_user(user_id: int) -> dict:
    if user_id > 100:
        raise Exception("User not found")  # returns 500
    return {"id": user_id, "name": "Alice"}

@controller Style

Status codes work the same way with controllers:

from evoid.web.controller import Service, Controller, GET, POST, DELETE

app = Service("api")

@Controller("/users")
class UserController:
    @POST("/", status=201)
    async def create_user(self, name: str, email: str) -> dict:
        return {"status": "created", "name": name}

    @GET("/{user_id}")
    async def get_user(self, user_id: int) -> dict:
        return {"id": user_id, "name": "Alice"}

    @DELETE("/{user_id}", status=204)
    async def delete_user(self, user_id: int) -> dict:
        return {"status": "deleted"}

Native Style

With native IOP, set the status in the handler’s return dict using the status_code key:

from evoid import Intent, Level, add_intent

CREATE_USER = Intent(
    name="create_user",
    level=Level.STANDARD,
    metadata={"method": "POST", "path": "/users"},
)

async def handle_create_user(intent: Intent) -> dict:
    body = intent.metadata.get("body", {})
    name = body.get("name")
    return {
        "status": "created",
        "name": name,
        "status_code": 201,
    }

add_intent(CREATE_USER, handle_create_user)

Summary