Index (rxmicro-documentation 0.4.1 API)

A B C D E H I L M N O P R S T U V W
All Classes All Packages

A

Author - Annotation Type in io.rxmicro.documentation: Denotes the author of the generated REST-based microservice documentation.
Author.List - Annotation Type in io.rxmicro.documentation: Defines several Author annotations on the same element.

B

BASE_ENDPOINT - io.rxmicro.documentation.IntroductionDefinition.Section: base endpoint standard section
BaseEndpoint - Annotation Type in io.rxmicro.documentation: Denotes the basic endpoint in the generated REST-based microservice documentation.
BASICS_SECTION - io.rxmicro.documentation.DocumentationDefinition.GenerationOutput: Only basic section

C

COMMON_CONCEPT - io.rxmicro.documentation.IntroductionDefinition.Section: Common concept standard section
Constants - Class in io.rxmicro.documentation: Default values.
CORS - io.rxmicro.documentation.ResourceGroupDefinition.Section: CORS standard section
CUSTOM_SECTION - io.rxmicro.documentation.IntroductionDefinition.Section: Custom section.
CUSTOM_SECTION - io.rxmicro.documentation.ResourceGroupDefinition.Section: Custom section.
customSection() - Method in annotation type io.rxmicro.documentation.IntroductionDefinition: Returns the custom sections
customSection() - Method in annotation type io.rxmicro.documentation.ResourceGroupDefinition: Returns the custom sections

D

DEFAULT_AUTHOR - Static variable in class io.rxmicro.documentation.Constants: Default author name
DEFAULT_EMAIL - Static variable in class io.rxmicro.documentation.Constants: Default author email
DEFAULT_LICENSE_NAME - Static variable in class io.rxmicro.documentation.Constants: Default license name
DEFAULT_LICENSE_URL - Static variable in class io.rxmicro.documentation.Constants: Default license url
description() - Method in annotation type io.rxmicro.documentation.SimpleErrorResponse: Returns the error description
Description - Annotation Type in io.rxmicro.documentation: Denotes the description of the generated REST-based microservice documentation.
destinationDirectory() - Method in annotation type io.rxmicro.documentation.DocumentationDefinition: Returns the custom destination directory
DocumentationDefinition - Annotation Type in io.rxmicro.documentation: A composite annotation that specifies the settings for generating a whole document.
DocumentationDefinition.GenerationOutput - Enum in io.rxmicro.documentation: Supported generation output
DocumentationVersion - Annotation Type in io.rxmicro.documentation: Denotes the version of REST-based microservice in the generated REST-based microservice documentation.

E

email() - Method in annotation type io.rxmicro.documentation.Author: Returns the author email
ERROR_MODEL - io.rxmicro.documentation.IntroductionDefinition.Section: Error model standard section
Example - Annotation Type in io.rxmicro.documentation: Denotes the model field value used as an example in the generated REST-based microservice documentation.
Example.List - Annotation Type in io.rxmicro.documentation: Defines several Example annotations on the same element.
exampleErrorMessage() - Method in annotation type io.rxmicro.documentation.SimpleErrorResponse: Returns the example of error message

H

HANDLER_NOT_FOUND - io.rxmicro.documentation.IntroductionDefinition.Section: `Handler not found` standard section
HTTP_VERBS - io.rxmicro.documentation.IntroductionDefinition.Section: HTTP verbs standard section

I

INCLUDE_REFERENCE - io.rxmicro.documentation.IncludeMode: Includes only reference of external document
includeDescription() - Method in annotation type io.rxmicro.documentation.SimpleErrorResponse: Returns the included description if it is necessary add a complex formatted description
IncludeDescription - Annotation Type in io.rxmicro.documentation: Denotes the AsciiDoc fragment to be imported into the generated REST-based microservice documentation.
includeMode() - Method in annotation type io.rxmicro.documentation.IncludeDescription: Returns the include mode.
includeMode() - Method in annotation type io.rxmicro.documentation.IntroductionDefinition: Returns the include mode.
includeMode() - Method in annotation type io.rxmicro.documentation.ResourceGroupDefinition: Returns the include mode.
IncludeMode - Enum in io.rxmicro.documentation: Represents an include mode for external documentation resources
INLINE_CONTENT - io.rxmicro.documentation.IncludeMode: Copies the content of included external document
introduction() - Method in annotation type io.rxmicro.documentation.DocumentationDefinition: Returns the composite annotation that specifies the settings for generating the Introduction section.
IntroductionDefinition - Annotation Type in io.rxmicro.documentation: A composite annotation that specifies the settings for generating the Introduction section.
IntroductionDefinition.Section - Enum in io.rxmicro.documentation: Supported section types
io.rxmicro.documentation - package io.rxmicro.documentation
isCustomSection() - Method in enum io.rxmicro.documentation.IntroductionDefinition.Section: Returns true if current section is custom.
isCustomSection() - Method in enum io.rxmicro.documentation.ResourceGroupDefinition.Section: Returns true if current section is custom.

L

License - Annotation Type in io.rxmicro.documentation: Denotes the license of REST-based microservice in the generated REST-based microservice documentation.
License.List - Annotation Type in io.rxmicro.documentation: Defines several License annotations on the same element.
LICENSES - io.rxmicro.documentation.IntroductionDefinition.Section: Licences standard section

M

ModelExceptionErrorResponse - Annotation Type in io.rxmicro.documentation: Denotes the exception class to be analyzed by the RxMicro Annotation Processor for generating the unsuccessful HTTP response description of REST-based microservice.
ModelExceptionErrorResponse.List - Annotation Type in io.rxmicro.documentation: Defines several ModelExceptionErrorResponse annotations on the same element.

N

name() - Method in annotation type io.rxmicro.documentation.Author: Returns the author name
name() - Method in annotation type io.rxmicro.documentation.License: Returns the license name

O

output() - Method in annotation type io.rxmicro.documentation.DocumentationDefinition: Returns the array of outputs.

P

PathVariables - Class in io.rxmicro.documentation: Predefined variables used during a generation of REST-based microservice documentation.
PROJECT_DIR - Static variable in class io.rxmicro.documentation.PathVariables: Project home directory

R

resource() - Method in annotation type io.rxmicro.documentation.DocumentationDefinition: Returns the composite annotation that specifies the settings for generating the ResourceDefinition section.
resource() - Method in annotation type io.rxmicro.documentation.IncludeDescription: Returns the resource name
ResourceDefinition - Annotation Type in io.rxmicro.documentation: A composite annotation that specifies the settings for generating the ResourceDefinition section.
resourceGroup() - Method in annotation type io.rxmicro.documentation.DocumentationDefinition: Returns the composite annotation that specifies the settings for generating the ResourceGroupDefinition section.
ResourceGroupDefinition - Annotation Type in io.rxmicro.documentation: A composite annotation that specifies the settings for generating the ResourceGroupDefinition section.
ResourceGroupDefinition.Section - Enum in io.rxmicro.documentation: Supported section types
RESOURCES_SECTION - io.rxmicro.documentation.DocumentationDefinition.GenerationOutput: Only resources section
rxmicro.documentation - module rxmicro.documentation: The basic module for creation a REST-based microservice documentation.

S

sectionOrder() - Method in annotation type io.rxmicro.documentation.IntroductionDefinition: Returns the current section order
sectionOrder() - Method in annotation type io.rxmicro.documentation.ResourceGroupDefinition: Returns the current section order
SimpleErrorResponse - Annotation Type in io.rxmicro.documentation: Contains metadata about the unsuccessful HTTP response of REST-based microservice.
SimpleErrorResponse.List - Annotation Type in io.rxmicro.documentation: Defines several SimpleErrorResponse annotations on the same element.
SINGLE_DOCUMENT - io.rxmicro.documentation.DocumentationDefinition.GenerationOutput: Whole document
SPECIFICATION - io.rxmicro.documentation.IntroductionDefinition.Section: Specification standard section
status() - Method in annotation type io.rxmicro.documentation.SimpleErrorResponse: Returns the status code
SUPPORTED_VARIABLES - Static variable in class io.rxmicro.documentation.PathVariables: All supported variables

T

TEMP_DIR - Static variable in class io.rxmicro.documentation.PathVariables: Temp directory provided by OS
Title - Annotation Type in io.rxmicro.documentation: Denotes the name of the generated REST-based microservice documentation.

U

url() - Method in annotation type io.rxmicro.documentation.License: Returns the license url
USER_DIR - Static variable in class io.rxmicro.documentation.PathVariables: Current user directory
USER_HOME - Static variable in class io.rxmicro.documentation.PathVariables: User home directory

V

value() - Method in annotation type io.rxmicro.documentation.Author.List: Returns the several Author annotations on the same element.
value() - Method in annotation type io.rxmicro.documentation.BaseEndpoint: Returns the basic endpoint
value() - Method in annotation type io.rxmicro.documentation.Description: Returns the description
value() - Method in annotation type io.rxmicro.documentation.DocumentationVersion: Returns the version of REST-based microservice
value() - Method in annotation type io.rxmicro.documentation.Example.List: Returns the several Example annotations on the same element.
value() - Method in annotation type io.rxmicro.documentation.Example: Returns the example value
value() - Method in annotation type io.rxmicro.documentation.License.List: Returns the several License annotations on the same element.
value() - Method in annotation type io.rxmicro.documentation.ModelExceptionErrorResponse.List: Returns the several ModelExceptionErrorResponse annotations on the same element.
value() - Method in annotation type io.rxmicro.documentation.ModelExceptionErrorResponse: Returns the HTTP error exception class
value() - Method in annotation type io.rxmicro.documentation.SimpleErrorResponse.List: Returns the several SimpleErrorResponse annotations on the same element.
value() - Method in annotation type io.rxmicro.documentation.Title: Returns the title
valueOf(String) - Static method in enum io.rxmicro.documentation.DocumentationDefinition.GenerationOutput: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.rxmicro.documentation.IncludeMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.rxmicro.documentation.IntroductionDefinition.Section: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.rxmicro.documentation.ResourceGroupDefinition.Section: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.rxmicro.documentation.DocumentationDefinition.GenerationOutput: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.rxmicro.documentation.IncludeMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.rxmicro.documentation.IntroductionDefinition.Section: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.rxmicro.documentation.ResourceGroupDefinition.Section: Returns an array containing the constants of this enum type, in the order they are declared.
VERSIONING - io.rxmicro.documentation.ResourceGroupDefinition.Section: Versioning standard section

W

withBodyParametersDescriptionTable() - Method in annotation type io.rxmicro.documentation.ResourceDefinition: Returns true if the RxMicro framework must generates a description table for HTTP body parameters
withExamples() - Method in annotation type io.rxmicro.documentation.ResourceDefinition: Returns true if the RxMicro framework must generates examples of HTTP requests and responses
withGeneratedDate() - Method in annotation type io.rxmicro.documentation.DocumentationDefinition: Returns true if the RxMicro framework must generate date of generating of REST-based microservice documentation
withHeadersDescriptionTable() - Method in annotation type io.rxmicro.documentation.ResourceDefinition: Returns true if the RxMicro framework must generates a description table for HTTP headers
withInternalErrorResponse() - Method in annotation type io.rxmicro.documentation.ResourceDefinition: Returns true if the RxMicro framework must generates a documentation for internal error response
withJsonSchema() - Method in annotation type io.rxmicro.documentation.ResourceDefinition: Returns true if the RxMicro framework must generates a JSON schema for HTTP requests and responses
withPathVariablesDescriptionTable() - Method in annotation type io.rxmicro.documentation.ResourceDefinition: Returns true if the RxMicro framework must generates a description table for path variables
withQueryParametersDescriptionTable() - Method in annotation type io.rxmicro.documentation.ResourceDefinition: Returns true if the RxMicro framework must generates a description table for HTTP query parameters
withReadMore() - Method in annotation type io.rxmicro.documentation.ResourceDefinition: Returns true if the RxMicro framework must generates read more links to external resources
withRequestIdResponseHeader() - Method in annotation type io.rxmicro.documentation.ResourceDefinition: Returns true if the RxMicro framework must generates standard Request-Id HTTP header
withStandardDescriptions() - Method in annotation type io.rxmicro.documentation.ResourceDefinition: Returns true if the RxMicro framework must generates a standard description for HTTP headers, parameters and path variables
withTips() - Method in annotation type io.rxmicro.documentation.DocumentationDefinition: Returns true if the RxMicro framework must generate tips for REST-based microservice documentation
withValidationResponse() - Method in annotation type io.rxmicro.documentation.ResourceDefinition: Returns true if the RxMicro framework must generates a documentation for validation response

A B C D E H I L M N O P R S T U V W
All Classes All Packages