Skip to main content
Redhat Developers  Logo
  • Products

    Featured

    • Red Hat Enterprise Linux
      Red Hat Enterprise Linux Icon
    • Red Hat OpenShift AI
      Red Hat OpenShift AI
    • Red Hat Enterprise Linux AI
      Linux icon inside of a brain
    • Image mode for Red Hat Enterprise Linux
      RHEL image mode
    • Red Hat OpenShift
      Openshift icon
    • Red Hat Ansible Automation Platform
      Ansible icon
    • Red Hat Developer Hub
      Developer Hub
    • View All Red Hat Products
    • Linux

      • Red Hat Enterprise Linux
      • Image mode for Red Hat Enterprise Linux
      • Red Hat Universal Base Images (UBI)
    • Java runtimes & frameworks

      • JBoss Enterprise Application Platform
      • Red Hat build of OpenJDK
    • Kubernetes

      • Red Hat OpenShift
      • Microsoft Azure Red Hat OpenShift
      • Red Hat OpenShift Virtualization
      • Red Hat OpenShift Lightspeed
    • Integration & App Connectivity

      • Red Hat Build of Apache Camel
      • Red Hat Service Interconnect
      • Red Hat Connectivity Link
    • AI/ML

      • Red Hat OpenShift AI
      • Red Hat Enterprise Linux AI
    • Automation

      • Red Hat Ansible Automation Platform
      • Red Hat Ansible Lightspeed
    • Developer tools

      • Red Hat Trusted Software Supply Chain
      • Podman Desktop
      • Red Hat OpenShift Dev Spaces
    • Developer Sandbox

      Developer Sandbox
      Try Red Hat products and technologies without setup or configuration fees for 30 days with this shared Openshift and Kubernetes cluster.
    • Try at no cost
  • Technologies

    Featured

    • AI/ML
      AI/ML Icon
    • Linux
      Linux Icon
    • Kubernetes
      Cloud icon
    • Automation
      Automation Icon showing arrows moving in a circle around a gear
    • View All Technologies
    • Programming Languages & Frameworks

      • Java
      • Python
      • JavaScript
    • System Design & Architecture

      • Red Hat architecture and design patterns
      • Microservices
      • Event-Driven Architecture
      • Databases
    • Developer Productivity

      • Developer productivity
      • Developer Tools
      • GitOps
    • Secure Development & Architectures

      • Security
      • Secure coding
    • Platform Engineering

      • DevOps
      • DevSecOps
      • Ansible automation for applications and services
    • Automated Data Processing

      • AI/ML
      • Data Science
      • Apache Kafka on Kubernetes
      • View All Technologies
    • Start exploring in the Developer Sandbox for free

      sandbox graphic
      Try Red Hat's products and technologies without setup or configuration.
    • Try at no cost
  • Learn

    Featured

    • Kubernetes & Cloud Native
      Openshift icon
    • Linux
      Rhel icon
    • Automation
      Ansible cloud icon
    • Java
      Java icon
    • AI/ML
      AI/ML Icon
    • View All Learning Resources

    E-Books

    • GitOps Cookbook
    • Podman in Action
    • Kubernetes Operators
    • The Path to GitOps
    • View All E-books

    Cheat Sheets

    • Linux Commands
    • Bash Commands
    • Git
    • systemd Commands
    • View All Cheat Sheets

    Documentation

    • API Catalog
    • Product Documentation
    • Legacy Documentation
    • Red Hat Learning

      Learning image
      Boost your technical skills to expert-level with the help of interactive lessons offered by various Red Hat Learning programs.
    • Explore Red Hat Learning
  • Developer Sandbox

    Developer Sandbox

    • Access Red Hat’s products and technologies without setup or configuration, and start developing quicker than ever before with our new, no-cost sandbox environments.
    • Explore Developer Sandbox

    Featured Developer Sandbox activities

    • Get started with your Developer Sandbox
    • OpenShift virtualization and application modernization using the Developer Sandbox
    • Explore all Developer Sandbox activities

    Ready to start developing apps?

    • Try at no cost
  • Blog
  • Events
  • Videos

Kill your API: the burger analogy

July 28, 2017
Owen Rubel
Related topics:
JavaMicroservices

Share:

    The other day I had a chat with the folks working on the OpenAPI initiative and I explained a trick that some of us in enterprises use to get greater speeds and scalability out of our API’s. At first, this may seem like complete sacrilege to those who are a stickler for standards but if you allow me to explain using a simple analogy, you may see how this can be useful…

    The ‘Burger Analogy’

    Say for instance your computer has to place an order to a restaurant. You would need to send a REQUEST in the format for that item to the restaurant. So if in this case, I want a ‘cheeseburger’, I would send the ‘content-type: food/cheeseburger’ format so they know what is being requested with the ID of my order and the restaurant would send back [bread,lettuce,tomato,meat,sauce,bread] .

    Now since they know what I requested, do you think I have to send additional data telling them the return format is also ‘food/cheeseburger‘? Of course not! That makes no sense! Naturally, I’m expecting ‘food/cheeseburger’… that’s what I sent in as my order! I actually would be very pissy if they sent back ‘food/taco’ (well not that pissy… but you get the idea).

    Getting What You Ordered

    This is what I explained to the OpenAPI initiative. In API’s we send two headers:

    • CONTENT-TYPE: a header to say what data we are REQUESTING with.
    • ACCEPT: a header to say what data we are RESPONDING with.

    But over 90% of API’s ALWAYS return what is requested! So, this is incredibly redundant. Why are we doing all this additional processing? Well it’s because we are trying to cover 100% of all use cases rather than just automating for 90% and then coding for the exceptions as they occur… as we should be doing.

    So of these HEADERS, which dictate FORMAT, only one is needed: Content-Type.

    But what about GET, OPTIONS or DELETE?

    You can fudge and use CONTENT-TYPE. Using one HEADER for everything makes it easier to automate, easier to code, easier to process and easier to request. This creates simplicity for our AJAX and API calls. No creating a dozen different ways to call things. Just ONE-WAY to call EVERYTHING and ONE-WAY to PROCESS.

    So one create an AJAX call like this


    $.ajax({
    type: POST,
    url: '`+window.url+`/v0.1/`+path+`' ,
    data: JSON.stringify(jsonData),
    headers:{
    'Content-Type': 'application/json'
    },
    success: function(json) {
    ...
    },
    error: function(jqXHR, textStatus, errorThrown) {
    ...
    },
    ));

    Usages in Frameworks

    This is already being used in several frameworks to gain speed advantages. One framework where you can find it immediately in is Grails:
    Grails 3.0 ignores the HTTP Accept header unless you add a grails.mime.use.accept.header = true setting to your application.groovy file. In other words, withFormat () will be completely unaffected by the Accept header without that setting.

    This change was added officially to Grails 3.0 after a suggestion made by myself on the forums mentioning how one didn’t have to use the ACCEPT header at all.

    Returning a Different Format

    What if I need to send JSON to get a resource and process that resource back as a PDF? Simple… Send the ACCEPT header from the controller/method. That way there is nothing to process but your client can receive a different CONTENT-TYPE and your docs can reflect it.

    In the example below I show a Spring-Boot Controller Method where I return the ACCEPT header:

       @RequestMapping(method=RequestMethod.GET,"/greeting")

       public Greeting greeting(@RequestParam(value="name", defaultValue="World") String name) {

           response.addHeader("Accept","application/pdf");

            ...                                             

    }

    Simplicity… Going Against Convention

    I know I’m going to get a 50/50 reaction; I generally do when I show things that greatly increase speed and scale but go in the face of convention. But for those who are always looking to get the most out of their environments, this is one of the tricks I have used for a few years now. ?

    Last updated: January 8, 2018

    Recent Posts

    • Ollama or vLLM? How to choose the right LLM serving tool for your use case

    • How to build a Model-as-a-Service platform

    • How Quarkus works with OpenTelemetry on OpenShift

    • Our top 10 articles of 2025 (so far)

    • The benefits of auto-merging GitHub and GitLab repositories

    Red Hat Developers logo LinkedIn YouTube Twitter Facebook

    Products

    • Red Hat Enterprise Linux
    • Red Hat OpenShift
    • Red Hat Ansible Automation Platform

    Build

    • Developer Sandbox
    • Developer Tools
    • Interactive Tutorials
    • API Catalog

    Quicklinks

    • Learning Resources
    • E-books
    • Cheat Sheets
    • Blog
    • Events
    • Newsletter

    Communicate

    • About us
    • Contact sales
    • Find a partner
    • Report a website issue
    • Site Status Dashboard
    • Report a security problem

    RED HAT DEVELOPER

    Build here. Go anywhere.

    We serve the builders. The problem solvers who create careers with code.

    Join us if you’re a developer, software engineer, web designer, front-end designer, UX designer, computer scientist, architect, tester, product manager, project manager or team lead.

    Sign me up

    Red Hat legal and privacy links

    • About Red Hat
    • Jobs
    • Events
    • Locations
    • Contact Red Hat
    • Red Hat Blog
    • Inclusion at Red Hat
    • Cool Stuff Store
    • Red Hat Summit
    © 2025 Red Hat

    Red Hat legal and privacy links

    • Privacy statement
    • Terms of use
    • All policies and guidelines
    • Digital accessibility

    Report a website issue