501 Not Implemented

The server does not know how to handle the request method. It’s either a very old server or a brand new API feature coming soon.

When and Why to Use It

Use this if you are building out an API, and someone tries to hit an endpoint you haven’t written the code for yet.

Usage Examples

Shokupan (Functional)

import { HttpException, post } from 'shokupan';

export const importData = post('/import', () => {
    // We've defined the route, but haven't written the CSV parser yet
    throw new HttpException('CSV Import coming in v2.0', 501);
});

Shokupan (Controller)

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

@Controller('/api')
export class ImportController {
    @Post('/import')
    importData() {
        // We've defined the route, but haven't written the CSV parser yet
        throw new HttpException('CSV Import coming in v2.0', 501);
    }
}

Express

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

app.post('/import', (req, res) => {
    // Endpoint defined, but logic missing
    res.status(501).json({ error: 'CSV Import coming in v2.0' });
});

Nest

import { Controller, Post, NotImplementedException } from '@nestjs/common';

@Controller('import')
export class ImportController {
  @Post()
  importData() {
    // Endpoint defined, but logic missing
    throw new NotImplementedException('CSV Import coming in v2.0');
  }
}

Koa

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

app.use(async ctx => {
  if (ctx.path === '/import' && ctx.method === 'POST') {
    // Endpoint defined, but logic missing
    ctx.status = 501;
    ctx.body = { error: 'CSV Import coming in v2.0' };
  }
});