Skip to main content

Enabling CORS in ASP.NET Web API

When testing some code I noticed that a specific AJAX call kept returning a 405 Method not allowed response. Although I was calling $.ajax({type: "POST"}) behind the scenes the browser changed the request to an OPTIONS request.

What was going on? What I didn’t notice at first sight was that the AJAX request was send to another domain, meaning I’m making a cross-origin HTTP request. For security reasons, browsers restrict cross-origin HTTP requests initiated from within scripts. Before you can do a cross-origin request, the browser will initiate a preflight CORS(Cross-Origin Resource Sharing) check. This explains the OPTION request going out.

It is up to the called API to handle this preflight check and return headers describing what’s allowed and not.

Permission/Feature Request Header Response Header
Origin Origin Access-Control-Allow-Origin
HTTP method Access-Control-Request-Method Access-Control-Allow-Method
Request headers Access-Control-Request-Headers Access-Control-Allow-Headers
Response headers   Access-Control-Expose-Headers
Credentials   Access-Control-Allow-Credentials
Cache preflight response   Access-Control-Max-Age

Enabling this for an ASP.NET Web API is easy:

  • Download and install the Microsoft.ASPNET Web API CORS NuGet package:
    • Install-Package Microsoft.AspNet.WebApi.Cors
  • Add the following code to your WebApiConfig.Register method:
public static class WebApiConfig
{
public static void Register(HttpConfiguration config)
{
// New code
config.EnableCors(new EnableCorsAttribute(origins: "http://mywebsite.test.be", headers: "*", methods: "*"));
config.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "api/{controller}/{id}",
defaults: new { id = RouteParameter.Optional }
);
}
}
view raw WebApiConfig.cs hosted with ❤ by GitHub
  • This is all you need to do.
    • Remark: In this case I globally enabled CORS support, but it is also possible to do this for a specific controller

Popular posts from this blog

Kubernetes–Limit your environmental impact

Reducing the carbon footprint and CO2 emission of our (cloud) workloads, is a responsibility of all of us. If you are running a Kubernetes cluster, have a look at Kube-Green . kube-green is a simple Kubernetes operator that automatically shuts down (some of) your pods when you don't need them. A single pod produces about 11 Kg CO2eq per year( here the calculation). Reason enough to give it a try! Installing kube-green in your cluster The easiest way to install the operator in your cluster is through kubectl. We first need to install a cert-manager: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.5/cert-manager.yaml Remark: Wait a minute before you continue as it can take some time before the cert-manager is up & running inside your cluster. Now we can install the kube-green operator: kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/download/kube-green.yaml Now in the namespace where we want t...

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.

.NET 9 - Goodbye sln!

Although the csproj file evolved and simplified a lot over time, the Visual Studio solution file (.sln) remained an ugly file format full of magic GUIDs. With the latest .NET 9 SDK(9.0.200), we finally got an alternative; a new XML-based solution file(.slnx) got introduced in preview. So say goodbye to this ugly sln file: And meet his better looking slnx brother instead: To use this feature we first have to enable it: Go to Tools -> Options -> Environment -> Preview Features Check the checkbox next to Use Solution File Persistence Model Now we can migrate an existing sln file to slnx using the following command: dotnet sln migrate AICalculator.sln .slnx file D:\Projects\Test\AICalculator\AICalculator.slnx generated. Or create a new Visual Studio solution using the slnx format: dotnet new sln --format slnx The template "Solution File" was created successfully. The new format is not yet recognized by VSCode but it does work in Jetbr...