6.8 Response Status

A Micronaut’s controller action responds with a 200 HTTP status code by default.

If the controller’s action returns a HttpResponse object, you can configure the status code for the response object with the status method.

    @Get(value = "/http-response", produces = MediaType.TEXT_PLAIN)
    public HttpResponse httpResponse() {
        return HttpResponse.status(HttpStatus.CREATED).body("success");
    }

    @Get(value = "/http-response", produces = MediaType.TEXT_PLAIN)
    HttpResponse httpResponse() {
        HttpResponse.status(HttpStatus.CREATED).body("success")
    }

    @Get(value = "/http-response", produces = [MediaType.TEXT_PLAIN])
    fun httpResponse(): HttpResponse<String> {
        return HttpResponse.status<String>(HttpStatus.CREATED).body("success")
    }

You can also use the @Status annotation.

    @Status(HttpStatus.CREATED)
    @Get(produces = MediaType.TEXT_PLAIN)
    public String index() {
        return "success";
    }

    @Status(HttpStatus.CREATED)
    @Get(produces = MediaType.TEXT_PLAIN)
    String index() {
        return "success"
    }

    @Status(HttpStatus.CREATED)
    @Get(produces = [MediaType.TEXT_PLAIN])
    fun index(): String {
        return "success"
    }

or even respond with an HttpStatus

    @Get("/http-status")
    public HttpStatus httpStatus() {
        return HttpStatus.CREATED;
    }

    @Get("/http-status")
    HttpStatus httpStatus() {
        HttpStatus.CREATED
    }

    @Get("/http-status")
    fun httpStatus(): HttpStatus {
        return HttpStatus.CREATED
    }