New annotations added to @RestResource and {@link oajr.annotation.RestMethod @RestMethod}
to simplify defining page title, text, and links on HTML views:
- @RestResource(pageTitle)
- @RestMethod(pageTitle)
- @RestResource(pageText)
- @RestMethod(pageText)
- @RestResource(pageLinks)
- @RestMethod(pageLinks)
// Old method
@RestResource(
properties={
@Property(name=HTMLDOC_title, value="System properties resource"),
@Property(name=HTMLDOC_description, value="REST interface for performing CRUD operations on system properties."),
@Property(name=HTMLDOC_navlinks, value="{up:'$R{requestParentURI}',options:'?method=OPTIONS'}")
}
)
// New method
@RestResource(
pageTitle="System properties resource",
pageDescription="REST interface for performing CRUD operations on system properties.",
pageLinks="{up:'$R{requestParentURI}',options:'?method=OPTIONS'}"
)
Typically you're going to simply want to use the title and description annotations
which apply to both the page title/text and the swagger doc:
@RestResource(
title="System properties resource",
description="REST interface for performing CRUD operations on system properties.",
pageLinks="{up:'$R{requestParentURI}',options:'?method=OPTIONS'}"
)