OxL Reference

fn requireHeader

Answers status (default 401) without calling the handler unless the request has header name (equal to value, when value is not empty): an authentication check.

Example:

oxl✓ checked in CI
use std.http { Server, ServerConfig, ServerHandle, Router, Request, Reply, Client, Header, HttpConfig, Response, Middleware, Next, withMiddleware, requireHeader, logRequests, timing, WebSocket, WsConfig, SseWriter, BodyWriter, chunks }

fn body(req: Request) -> str {
  match req.text() {
    str t => t
    DecodeError _ => ""
  }
}

fn run() -> () | NetError | DecodeError | Panicked  net, io, time {
  let srv = Server.bind(ServerConfig{ port: 0, followNode: false })?
  defer srv.close()
  let stop = srv.handle()
  let base = "http://127.0.0.1:{srv.port()}"
  let router = Router.new().get("/api", (req: Request) => Reply.text("data")).layer(requireHeader("authorization", "Bearer k1"))
  scope {
    spawn stop.serve(router)
    print((Client.get("{base}/api")?).status)
    print((Client.get("{base}/api", [Header{ name: "Authorization", value: "Bearer k1" }])?).status)
    stop.shutdown()
    ()
  }?
}

fn main() io, net, time {
  match run() {
    NetError _ => print("net error")
    DecodeError _ => print("decode error")
    Panicked _ => print("panicked")
    _ => {}
  }
}
Output
401
200
pub(api) fn requireHeader(name: str, value: str = "", status: i64 = 401) -> Middleware

Since. 1.0.0-beta

Parameters

NameType
namestr
valuestr = ""
statusi64 = 401

Returns

Middleware

Effects

none declared (pure unless the body says otherwise)

Defined in: std/http/http.oxl:3272

See also