406 Not Acceptable

The client requested a specific content type (like XML), but the server can only provide another type (like JSON).

When and Why to Use It

Use this if your API only speaks JSON, but the client sends an ‘Accept: text/xml’ header explicitly refusing to accept JSON.

Usage Examples

Shokupan (Functional)

import { HttpException, get } from 'shokupan';

export const getResource = get('/resource', () => {
    throw new HttpException('Not Acceptable', 406);
});

Shokupan (Controller)

import { Controller, Get, HttpException } from 'shokupan';

@Controller('/api')
export class ExampleController {
    @Get('/resource')
    getResource() {
        throw new HttpException('Not Acceptable', 406);
    }
}

Express

import express from 'express';
const app = express();

app.get('/resource', (req, res) => {
    res.status(406).json({ error: 'Not Acceptable' });
});

Nest

import { Controller, Get, HttpException } from '@nestjs/common';

@Controller('api')
export class ExampleController {
  @Get('resource')
  getResource() {
    throw new HttpException('Not Acceptable', 406);
  }
}

Koa

import Koa from 'koa';
const app = new Koa();

app.use(async ctx => {
  if (ctx.path === '/resource' && ctx.method === 'GET') {
    ctx.status = 406;
    ctx.body = { error: 'Not Acceptable' };
  }
});