org.jsondoc.core.annotation

Annotation Type ApiErrors

@Documented
 @Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
public @interface ApiErrors

This annotation is to be used on your controller class or method and represents the possible errors returned by the API endpoints.

When the @ApiErrors is present at the class level, defined errors will be applied to all member methods. Member methods can override the errors declared at the class level and provide more specific ones.

Author:

Fabio Maffioletti

See Also:

ApiError

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
ApiError[]	apierrors An array of ApiError annotations

Element Detail

apierrors

public abstract ApiError[] apierrors

An array of ApiError annotations

Returns:

See Also:

ApiError