RestInfoProvider

The {@link oajr.RestInfoProvider} class is used to find the title and description for your resource and also generate the Swagger documentation. It can be overridden to provide your own custom Swagger documentation.

The methods on this interface are:

- {@link oajr.RestInfoProvider}
  - {@link oajr.RestInfoProvider#getSwagger(RestRequest) getSwagger(RestRequest)}
  - {@link oajr.RestInfoProvider#getSiteName(RestRequest) getSiteName(RestRequest)}
  - {@link oajr.RestInfoProvider#getTitle(RestRequest) getTitle(RestRequest)}
  - {@link oajr.RestInfoProvider#getDescription(RestRequest) getDescription(RestRequest)}
  - {@link oajr.RestInfoProvider#getMethodSummary(Method,RestRequest) getMethodSummary(Method,RestRequest)}
  - {@link oajr.RestInfoProvider#getMethodDescription(Method,RestRequest) getMethodDescription(Method,RestRequest)}

The info provider in turn supplies the information returned by the following methods:

- {@link oajr.RestRequest}
  - {@link oajr.RestRequest#getSwagger() getSwagger()}
  - {@link oajr.RestRequest#getSiteName() getSiteName()}
  - {@link oajr.RestRequest#getResourceTitle() getResourceTitle()}
  - {@link oajr.RestRequest#getResourceDescription() getResourceDescription()}
  - {@link oajr.RestRequest#getMethodSummary() getMethodSummary()}
  - {@link oajr.RestRequest#getMethodDescription() getMethodDescription()}

Info providers are registered through the following property:

- {@link oajr.RestContext#REST_infoProvider}

While you can implement this interface from scratch, you may want to instead consider extending from the BasicRestInfoProvider class described next.