Module io.helidon.declarative.codegen.model

Package io.helidon.declarative.codegen.model.http

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

public interface RestEndpoint
extends Prototype.Api, HttpAnnotated, ModelElement

A REST endpoint may be a client endpoint or a server endpoint.

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RestEndpoint.Builder	Fluent API builder for RestEndpoint.
static class	RestEndpoint.BuilderBase<BUILDER extends RestEndpoint.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends RestEndpoint>	Fluent API builder base for RestEndpoint.

Method Summary

Modifier and Type	Method	Description
static RestEndpoint.Builder	builder()	Create a new fluent API builder to customize configuration.
static RestEndpoint.Builder	builder(RestEndpoint instance)	Create a new fluent API builder from an existing instance.
List<RestMethod>	methods()	Methods that have a rest annotation (HTTP method).

Methods inherited from interface io.helidon.declarative.codegen.model.http.HttpAnnotated

computedHeaders, consumes, headers, path, produces

Methods inherited from interface io.helidon.declarative.codegen.model.http.ModelElement

annotations, type

Method Details

builder

static RestEndpoint.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static RestEndpoint.Builder builder(RestEndpoint instance)

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