How to set a different Http Status in loopback 4

Question

I can't find any ressources on how to change the success HTTP code using loopback 4.

For example :

201 "created" on post method

204 "no content" on delete method

I tried to specify this in the @api decorator but this change is not reflected in the actual response.

Thank's for your help !

Answer 1

I can't find any ressources on how to change the success HTTP code using loopback 4.

We don't have first-class support for this feature yet. The current workaround is to inject the Response object into your controller method and set the status code directly via Express/Node.js core API.

export class TodoController {
  constructor(
    @repository(TodoRepository) protected todoRepo: TodoRepository,
    @inject(RestBindings.Http.RESPONSE) protected response: Response,
  ) {}

  async createTodo(@requestBody() todo: Todo): Promise<Todo> {
    this.response.status(401);
    // ...
  }
}

Don't forget to import Response and RestBindings from @loopback/rest, and inject from @loopback/core. Add the below imports in your controller.

import { Response, RestBindings } from '@loopback/rest';
import { inject } from '@loopback/core';

201 "created" on post method

See the discussion in https://github.com/strongloop/loopback-next/issues/788. The difficult part is how to figure out what URL to send in the Location response header.

204 "no content" on delete method

Just change your controller method to return undefined instead of the current {count: 1} object. I believe this is the default behavior for CRUD controllers scaffolded by our lb4 tool.

export class TodoController {
  // ...
  @del('/todos/{id}', {
    responses: {
      '204': {
        description: 'Todo DELETE success',
      },
    },
  })
  async deleteTodo(@param.path.number('id') id: number): Promise<void> {
    await this.todoRepo.deleteById(id);
  }