@HtmlDocConfig(navlinks={"up: request:/..","options: servlet:/?method=OPTIONS","stats: servlet:/stats"}) @JsonSchemaConfig(addDescriptionsTo="bean,collection,array,map,enum", addExamplesTo="bean,collection,array,map", ignoreTypes="Swagger,org.apache.juneau.dto.html5.*", useBeanDefs="true") @BeanConfig(swaps=SwaggerUI.class) public interface BasicRestMethods
Modifier and Type | Method and Description |
---|---|
void |
error()
[* /error] - Error occurred.
|
Swagger |
getOptions(RestRequest req)
[OPTIONS /*] - Show resource options.
|
Swagger |
getOptions2(RestRequest req)
[GET /options] - Show resource options.
|
RestContextStats |
getStats(RestRequest req)
[GET /stats] - Timing statistics.
|
@RestMethod(name="OPTIONS", path="/*", summary="Swagger documentation", description="Swagger documentation for this resource.") @HtmlDocConfig(rank=10, navlinks={"back: servlet:/","json: servlet:/?method=OPTIONS&Accept=text/json&plainText=true"}, aside="NONE") Swagger getOptions(RestRequest req)
req
- The HTTP request.@RestMethod(name="OPTIONS", path="/*", summary="Swagger documentation", description="Swagger documentation for this resource.") @HtmlDocConfig(rank=10, navlinks={"back: servlet:/","json: servlet:/?Accept=text/json&plainText=true"}, aside="NONE") Swagger getOptions2(RestRequest req)
req
- The HTTP request.@RestMethod(name="*", path="/error", summary="Error occurred", description="An error occurred during handling of the request.") void error()
Servlet chains will often automatically redirect to
These responses should be left as-is without any additional processing.
@RestMethod(name="GET", path="/stats", summary="Timing statistics", description="Timing statistics for method invocations on this resource.") @HtmlDocConfig(rank=10, navlinks={"back: servlet:/","json: servlet:/stats?Accept=text/json&plainText=true"}, aside="NONE") RestContextStats getStats(RestRequest req)
Timing statistics for method invocations on this resource.
req
- The HTTP request.Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.