io.micronaut.rss.jsonfeed.http

Class JsonFeedController

java.lang.Object

io.micronaut.rss.jsonfeed.http.JsonFeedController

@Controller(value="${jsonfeed.root-path:/feeds}")
public class JsonFeedController
extends java.lang.Object

Exposes an endpoint, by default /feeds/json, which return a JSON Feed.

Since:

2.2.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_JSON_FEED

Constructor Summary

Constructors

Constructor and Description
JsonFeedController(JsonFeedProvider jsonFeedProvider)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<io.micronaut.http.MutableHttpResponse<?>>	index(java.lang.Integer maxNumberOfItems, java.lang.Integer pageNumber)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APPLICATION_JSON_FEED

public static final java.lang.String APPLICATION_JSON_FEED

See Also:

Constant Field Values

Constructor Detail

JsonFeedController

public JsonFeedController(JsonFeedProvider jsonFeedProvider)

Parameters:

jsonFeedProvider - JSON Feed Provider

Method Detail

index

@Produces(value="application/json+feed")
 @Get(value="${jsonfeed.path:/json}{?maxNumberOfItems,pageNumber}")
public io.reactivex.Single<io.micronaut.http.MutableHttpResponse<?>> index(@QueryValue @Nullable
                                                                                                                                                                                        java.lang.Integer maxNumberOfItems,
                                                                                                                                                                                        @QueryValue @Nullable
                                                                                                                                                                                        java.lang.Integer pageNumber)

Parameters:

maxNumberOfItems - Max number of items in the JSON Feed. Optional.

pageNumber - Requested Page. Optional.

Returns:

a JSON Feed.