Custom Routes

Weave allows you to define custom routes to handle requests outside of the standard Weave event system. This is useful for creating API endpoints, handling file uploads, or integrating with external services.

Adding Custom Routes

Custom routes are added through the :handlers option when starting your Weave application. These routes use Compojure syntax and are merged with Weave's internal routes.

(weave/run view-fn
  {:handlers [(GET "/api/data" request (api-handler request))
              (POST "/api/upload" request (upload-handler request))
              (GET "/api/download/:id" [id :as request] (download-handler id request))]})

Route Handlers

Route handlers are regular Ring handler functions that take a request map and return a response map:

(defn api-handler [request]
  {:status 200
   :headers {"Content-Type" "application/json"}
   :body "{\"message\":\"Hello from API\"}"})

(defn download-handler [id request]
  {:status 200
   :headers {"Content-Type" "application/octet-stream"}
   :body (get-file-by-id id)})

Authentication for Custom Routes

Custom routes don't automatically use Weave's authentication system. To protect your routes, you need to manually check the request for authentication information,

(defn authenticated-api [request]
  (if (:identity request)
    {:status 200
     :headers {"Content-Type" "application/json"}
     :body "{\"data\":\"Protected data\"}"}
    {:status 403
     :headers {"Content-Type" "application/json"}
     :body "{\"error\":\"Unauthorized\"}"}))

Accessing Weave Context

Custom routes have access to the same request context as Weave handlers, including session information:

(defn session-info [request]
  (let [session-id (session/get-sid request)]
    {:status 200
     :headers {"Content-Type" "application/json"}
     :body (str "{\"session\":\"" session-id "\"}")}))