Restful Hypermedia

# HAL format responses
from flask import jsonify

@app.route('/users/<int:id>')
def get_user(id):
    user = db.get_user(id)

    # HAL response
    response = jsonify({
        "_links": {
            "self": {"href": f"/users/{id}"},
            "collection": {"href": "/users"},
            "orders": {"href": f"/users/{id}/orders"},
            "profile": {"href": "/profiles/users"}
        },
        "id": user.id,
        "name": user.name,
        "email": user.email
    })

    response.headers['Content-Type'] = 'application/hal+json'
    return response

# HAL collection
@app.route('/users')
def list_users():
    users = db.get_users()

    response = jsonify({
        "_links": {
            "self": {"href": "/users"},
            "next": {"href": "/users?page=2"},
            "find": {"href": "/users{?id}", "templated": True}
        },
        "_embedded": {
            "users": [{
                "_links": {"self": {"href": f"/users/{u.id}"}},
                "id": u.id,
                "name": u.name
            } for u in users]
        },
        "page": 1,
        "total": len(users)
    })

    response.headers['Content-Type'] = 'application/hal+json'
    return response

// JSON-LD response
app.get('/api/users/:id', (req, res) => {
  const user = db.findUser(req.params.id);

  res.json({
    '@context': {
      '@vocab': 'https://schema.org/',
      'name': 'name',
      'email': 'email'
    },
    '@id': `/api/users/${user.id}`,
    '@type': 'Person',
    'name': user.name,
    'email': user.email,
    'knows': user.friendIds.map(id => ({ '@id': `/api/users/${id}` }))
  });
});

# Siren format
@app.route('/orders/<int:id>')
def get_order(id):
    order = db.get_order(id)

    response = jsonify({
        "class": ["order"],
        "properties": {
            "id": order.id,
            "total": order.total,
            "status": order.status
        },
        "entities": [
            {
                "class": ["item"],
                "rel": ["items"],
                "href": f"/orders/{id}/items"
            }
        ],
        "actions": [
            {
                "name": "cancel",
                "title": "Cancel Order",
                "method": "POST",
                "href": f"/orders/{id}/cancel",
                "type": "application/json"
            }
        ],
        "links": [
            {"rel": ["self"], "href": f"/orders/{id}"},
            {"rel": ["customer"], "href": f"/users/{order.userId}"}
        ]
    })

    response.headers['Content-Type'] = 'application/vnd.siren+json'
    return response