All Classes
-
All Classes Class Summary Enum Summary Annotation Types Summary Class Description ApiAllowedValue Define the allowed values for a parameter.ApiAllowedValues Container annotation forApiAllowedValues.ApiCommonResponse Document a common Response on class level, the response will be added to every method inside that class.ApiCommonResponses Container annotation forApiCommonResponses.ApiCurl Tells Neberus to generate an example curl.ApiDescription If provided, the value of this will be used as description of the method instead of the javadoc comment.ApiDocumentation Enables neberus documentation for a class containing REST methods.ApiEntity Define a response entity.ApiExample Define a example for a specific value.ApiHeader Define a response Header within aApiResponse.ApiHeaderDefinition Define a Header on class level, this can be used to provided descriptions of headers that are reused many times.ApiHeaderDefinitions Container annotation forApiHeaderDefinitions.ApiHeaders Container annotation forApiHeaders.ApiIgnore Exclude a request parameter, DTO field or a whole REST method from documentation.ApiLabel Defines the name of a REST class or method.ApiOptional Declare a parameter as optional.ApiParameter Defines a custom parameter for a REST method.ApiParameter.Type ApiParameters Container annotation forApiParameters.ApiRequestEntities Container annotation for @ApiRequestEntity.ApiRequestEntity Define a request entity for a specific content-type.ApiRequired Declare a parameter as required.ApiResponse Document a Response.ApiResponses Container annotation forApiResponses.ApiStatus ApiType Define the type that should be displayed instead of the actual type.ApiUsecase Defines a specific usecase of the REST service.ApiUsecaseMethod A specific REST method used in an usecase.ApiUsecaseParam Parameter used by a REST method in a usecase.ApiUsecaseRequestBody Request body for a REST method in a usecase.ApiUsecaseResponseBody Response body for a REST method in a usecase.ApiUsecases Container for multipleApiUsecaseannotations.AsciiDocPrinter ClassParser Parses class related things.DocletOption DocPrinter FileUtils FormParameters Generic container for form params.JavaDocUtils MarkdownPrinter MethodParser Parses all stuff related to a single REST method.NeberusModule NeberusPrinter OpenApiV3JsonPrinter Options Options that may be specified for the docletOptions.Markup RequiredStatus RestClassData Contains data belonging the REST service class.RestMethodData RestMethodData.AllowedValue RestMethodData.Entity RestMethodData.Example RestMethodData.HeaderInfo RestMethodData.MethodData General method data.RestMethodData.ParameterInfo RestMethodData.ParameterType RestMethodData.RequestData Request related dataRestMethodData.ResponseData Response related dataRestUsecaseData RestUsecaseData.UsecaseData RestUsecaseData.UsecaseMethodData RestUsecaseData.UsecaseValueInfo ShortCode [[key][value]]ShortCodeExpander UsecaseParser Parses usecase related things.