Read Methods

Annotating a method with the Read annotation will cause it to respond to GET requests.

CurrentDateEndpoint

import io.micronaut.management.endpoint.annotation.Endpoint;
import io.micronaut.management.endpoint.annotation.Read;
@Endpoint(id = "date",
        prefix = "custom",
        defaultEnabled = true,
        defaultSensitive = false)
public class CurrentDateEndpoint {
    private Date currentDate;
    @Read
    public Date currentDate() {
        return currentDate;
    }
}

CurrentDateEndpoint

import io.micronaut.management.endpoint.annotation.Endpoint
import io.micronaut.management.endpoint.annotation.Read
@Endpoint(id = "date",
        prefix = "custom",
        defaultEnabled = true,
        defaultSensitive = false)
class CurrentDateEndpoint {
    Date currentDate
    @Read
    Date currentDate() {
        return currentDate
    }
}

CurrentDateEndpoint

import io.micronaut.management.endpoint.annotation.Endpoint
import io.micronaut.management.endpoint.annotation.Read
@Endpoint(id = "date", prefix = "custom", defaultEnabled = true, defaultSensitive = false)
class CurrentDateEndpoint {
    private var currentDate: Date? = null
    @Read
    fun currentDate(): Date? {
        return currentDate
    }
}

The above method responds to the following request:

$ curl -X GET localhost:55838/date
1526085903689

The Read annotation accepts an optional produces argument, which sets the media type returned from the method (default is application/json):

CurrentDateEndpoint

import io.micronaut.management.endpoint.annotation.Endpoint;
import io.micronaut.management.endpoint.annotation.Read;
import io.micronaut.http.MediaType;
import io.micronaut.management.endpoint.annotation.Selector;
@Endpoint(id = "date",
        prefix = "custom",
        defaultEnabled = true,
        defaultSensitive = false)
public class CurrentDateEndpoint {
    private Date currentDate;
    @Read(produces = MediaType.TEXT_PLAIN) (1)
    public String currentDatePrefix(@Selector String prefix) {
        return prefix + ": " + currentDate;
    }
}

CurrentDateEndpoint

import io.micronaut.management.endpoint.annotation.Endpoint
import io.micronaut.management.endpoint.annotation.Read
import io.micronaut.http.MediaType
import io.micronaut.management.endpoint.annotation.Selector
@Endpoint(id = "date",
        prefix = "custom",
        defaultEnabled = true,
        defaultSensitive = false)
class CurrentDateEndpoint {
    Date currentDate
    @Read(produces = MediaType.TEXT_PLAIN) (1)
    String currentDatePrefix(@Selector String prefix) {
        return "${prefix}: ${currentDate}"
    }
}

CurrentDateEndpoint

import io.micronaut.management.endpoint.annotation.Endpoint
import io.micronaut.management.endpoint.annotation.Read
import io.micronaut.http.MediaType
import io.micronaut.management.endpoint.annotation.Selector
@Endpoint(id = "date", prefix = "custom", defaultEnabled = true, defaultSensitive = false)
class CurrentDateEndpoint {
    private var currentDate: Date? = null
    @Read(produces = [MediaType.TEXT_PLAIN]) (1)
    fun currentDatePrefix(@Selector prefix: String): String {
        return "$prefix: $currentDate"
    }
}

The above method responds to the following request:

$ curl -X GET localhost:8080/date/the_date_is
the_date_is: Fri May 11 19:24:21 CDT