CORS

Ys offers full support for CORS. Ys' CORS module is implemented as a middleware that can be bound to a router instance.

The CORS middleware will handle Preflight requests and apply the specified CORS policy automatically.

To quickly initialize CORS middleware with sensible defaults, use the ys_cors_allow_all utility.

ys_router_attr *attr = ys_router_attr_init();
ys_use_cors(attr, ys_cors_allow_all());

ys_cors_allow_all configures the following CORS policy

property	value
allowed origins	*
allowed methods	HEAD, GET, POST, PATCH, PUT, DELETE
allowed headers	*
allow credentials	false
max age	0
exposed headers	none
use options passthrough	false

NOTE

You may use a wildcard (*) to set the allowed headers or origins to allow all values.

To build your own CORS policy, use ys_cors_opts_init to initialize a new CORS options object, then use the cors_set_* utilities to customize it.

ys_cors_opts *opts = ys_cors_opts_init();

ys_cors_allow_methods(opts, YS_METHOD_GET, YS_METHOD_DELETE);
ys_cors_allow_headers(opts, "X-Test-Header");
ys_cors_expose_headers(opts, "X-Powered-By");
ys_cors_allow_origins(opts, "test.com");

Finally, we set the ys_cors_opts* on the router attributes object.

ys_router_attr *attr = ys_router_attr_init();
ys_use_cors(attr, cors);

See a full accounting of the available CORS APIs here.

CORS ​

CORS