Package io.muserver.rest

This package contains the JAX-RS implementation for mu-server. To create a JAX-RS Rest Resource handler, see RestHandlerBuilder.restHandler(java.lang.Object...)

Interface Summary

Interface	Description
Authorizer	A class that can check if a principle is in a given role.
SchemaObjectCustomizer	A class that can customize the SchemaObjects generated in OpenAPI documents for JAX-RS resources.
UserPassAuthenticator	An authenticator used by BasicAuthSecurityFilter which can look up a user based on a username and password.

Class Summary

Class	Description
BasicAuthSecurityFilter	A filter that can handle Basic Authentication
CORSConfig	CORS configuration for REST resources.
CORSConfigBuilder	A builder to set configuration for CORS requests.
MuRuntimeDelegate	The JAX-RS runtime delegate for mu-server.
PathMatch	The result of matching a template URI against a real request URI.
RestHandler	A handler that serves JAX-RS resources.
RestHandlerBuilder	Used to create a RestHandler for handling JAX-RS REST resources.
SchemaObjectCustomizerContext	Provides the context that a SchemaObject is in when customizing the schema in a SchemaObjectCustomizer
UriPattern	A pattern representing a URI template, such as /fruit or /fruit/{name} etc.

Enum Summary

Enum	Description
CollectionParameterStrategy	Specifies how to handle lists or sets in querystring parameters
SchemaObjectCustomizerTarget	The aspect of the API that a SchemaObject refers to

Annotation Types Summary

Annotation Type	Description
ApiResponse	Describes a response code and description for an API method, for documentation purposes.
ApiResponses	Describes multiple response codes and descriptions for an API method, for documentation purposes.
Description	Provides a description of a class, method, or parameter for use in documentation.
Required	Specifies that a parameter in a rest method is required
ResponseHeader	Describes an HTTP Header that is returned by a rest method.