Flaxon 0.3.0 and Teloce-Py 0.3.0 are available on PyPI. Release instructions are maintained on this site; source links identify the framework snapshot. Check version and upgrade guidance.

Framework source · Markdown

Basic API Example

This example demonstrates a simple REST API built with Flaxon.

Application Code

# app.py

from flaxon import Flaxon, JSONResponse, NotFound
from flaxon.validation import Schema, fields

app = Flaxon("basic-api", debug=True)


# Health check
@app.get("/service-health")
async def health():
    return {
        "status": "healthy",
        "service": "basic-api",
    }


# Home endpoint
@app.get("/")
async def home():
    return {
        "message": "Welcome to the Basic API",
        "endpoints": [
            "GET /service-health",
            "GET /users",
            "GET /users/<id>",
            "POST /users",
            "PUT /users/<id>",
            "DELETE /users/<id>",
        ],
    }


# Schema for user creation
class CreateUser(Schema):
    name = fields.StrField(
        required=True,
        min_length=2,
        max_length=80,
    )
    email = fields.EmailField(required=True)
    age = fields.IntField(
        required=False,
        minimum=13,
        maximum=120,
    )


# Schema for user update
class UpdateUser(Schema):
    name = fields.StrField(
        required=False,
        min_length=2,
        max_length=80,
    )
    email = fields.EmailField(required=False)
    age = fields.IntField(
        required=False,
        minimum=13,
        maximum=120,
    )


# In-memory storage
users = []
user_id_counter = 1


# List users
@app.get("/users")
async def list_users():
    return users


# Get single user
@app.get("/users/<int:user_id>")
async def get_user(user_id: int):
    for user in users:
        if user["id"] == user_id:
            return user

    raise NotFound("User not found")


# Create user
@app.post("/users")
async def create_user(data: CreateUser):
    global user_id_counter

    user = data.to_dict()
    user["id"] = user_id_counter

    user_id_counter += 1
    users.append(user)

    return JSONResponse({
        "created": True,
        "user": user,
    }, status_code=201)


# Update user
@app.put("/users/<int:user_id>")
async def update_user(user_id: int, data: UpdateUser):
    for user in users:
        if user["id"] == user_id:
            changes = {
                key: value
                for key, value in data.to_dict().items()
                if value is not None
            }
            user.update(changes)

            return {
                "updated": True,
                "user": user,
            }

    raise NotFound("User not found")


# Delete user
@app.delete("/users/<int:user_id>")
async def delete_user(user_id: int):
    for index, user in enumerate(users):
        if user["id"] == user_id:
            users.pop(index)

            return {
                "deleted": True,
                "id": user_id,
            }

    raise NotFound("User not found")
````

---

## Running the Application

```bash
# Install dependencies
pip install flaxon[standard]

# Run the application
flaxon run app:app --reload

The API will be available at:

http://localhost:8000

Testing the API

Health Check

curl http://localhost:8000/service-health

Response:

{
    "status": "healthy",
    "service": "basic-api"
}

Create a User

curl -X POST http://localhost:8000/users \
  -H "Content-Type: application/json" \
  -d '{"name":"Alice","email":"alice@example.com","age":30}'

Response:

{
    "created": true,
    "user": {
        "name": "Alice",
        "email": "alice@example.com",
        "age": 30,
        "id": 1
    }
}

List All Users

curl http://localhost:8000/users

Get a User

curl http://localhost:8000/users/1

Update a User

curl -X PUT http://localhost:8000/users/1 \
  -H "Content-Type: application/json" \
  -d '{"name":"Alice Updated"}'

Delete a User

curl -X DELETE http://localhost:8000/users/1

Response:

{
    "deleted": true,
    "id": 1
}

Next Steps

For production applications:

  • Replace in-memory storage with a database
  • Add authentication using Flaxon Security
  • Add pagination for large datasets
  • Add rate limiting
  • Add automated tests
  • Deploy using Docker or cloud hosting