Skip to main content

ASP.NET Web API Request Batching

Most applications I’m building today are using a kind of Web API. This works great, but leads to chatty interfaces, requiring a  large number of requests to get all the required data. In situations where the API is only for internal usage and you don’t want to share it with other applications, your application can benefit from a technique called ‘Request Batching’.

Remark: Be aware that Batch requests are not REST-compliant. So if you are creating a public API stop reading… Glimlach

What is it?

Request batching combines multiple API requests into a single POST request. HTTP provides this out-of-the-box using a special content type called Multipart. On server-side, requests are unpacked and dispatched to the appropriate API methods. All responses are packed together and sent back to the client as a single HTTP response. The nice thing is that it is already supported by ASP.NET web API and you don’t need a lot of extra code to get it working.

Enable Request Batching in ASP.NET Web API

The only thing you need to do to get it working inside ASP.NET Web API is defining an extra route:

Inside the route you can use the  DefaultHttpBatchHandler or create your own custom implementation:

In the above sample I changed the ExecutionOrder property. By setting this to non-sequential, API requests are executed in parallel.

From the client, you can consume this Batch API like this:

Popular posts from this blog

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.

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...

DevToys–A swiss army knife for developers

As a developer there are a lot of small tasks you need to do as part of your coding, debugging and testing activities.  DevToys is an offline windows app that tries to help you with these tasks. Instead of using different websites you get a fully offline experience offering help for a large list of tasks. Many tools are available. Here is the current list: Converters JSON <> YAML Timestamp Number Base Cron Parser Encoders / Decoders HTML URL Base64 Text & Image GZip JWT Decoder Formatters JSON SQL XML Generators Hash (MD5, SHA1, SHA256, SHA512) UUID 1 and 4 Lorem Ipsum Checksum Text Escape / Unescape Inspector & Case Converter Regex Tester Text Comparer XML Validator Markdown Preview Graphic Col...