Interface RestEndpoint
- All Superinterfaces:
HttpAnnotated, ModelElement, Prototype.Api
- All Known Subinterfaces:
ClientEndpoint, ServerEndpoint
- All Known Implementing Classes:
ClientEndpoint.BuilderBase.ClientEndpointImpl, RestEndpoint.BuilderBase.RestEndpointImpl, ServerEndpoint.BuilderBase.ServerEndpointImpl
A REST endpoint may be a client endpoint or a server endpoint.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic classFluent API builder forRestEndpoint.static classRestEndpoint.BuilderBase<BUILDER extends RestEndpoint.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends RestEndpoint>Fluent API builder base forRestEndpoint. -
Method Summary
Modifier and TypeMethodDescriptionstatic RestEndpoint.Builderbuilder()Create a new fluent API builder to customize configuration.static RestEndpoint.Builderbuilder(RestEndpoint instance) Create a new fluent API builder from an existing instance.methods()Methods that have a rest annotation (HTTP method).Methods inherited from interface HttpAnnotated
computedHeaders, consumes, headers, path, producesModifier and TypeMethodDescriptionList of computed header values.consumes()List of consumed media types (from server endpoint point of view).headers()List of configured header values.path()Path of the endpoint/method (optional).produces()List of produced media types (from server endpoint point of view).Methods inherited from interface ModelElement
annotations, typeModifier and TypeMethodDescriptionAll annotations on this element, and inherited from supertype/interface and annotations.type()Type of this element.
-
Method Details
-
builder
Create a new fluent API builder to customize configuration.- Returns:
- a new builder
-
builder
Create a new fluent API builder from an existing instance.- Parameters:
instance- an existing instance used as a base for the builder- Returns:
- a builder based on an instance
-
methods
List<RestMethod> methods()Methods that have a rest annotation (HTTP method).- Returns:
- all rest methods defined
-