Module rxmicro.documentation
Package io.rxmicro.documentation
The root package for the
rxmicro.documentation module.- Since:
- 0.4
- Author:
- nedis
-
Class Summary Class Description DocumentationConstants Default values.PathVariables Predefined variables used during a generation of REST-based microservice documentation. -
Enum Summary Enum Description DocumentationDefinition.GenerationOutput Supported generation output.IncludeMode Represents an include mode for external documentation resources.IntroductionDefinition.Section Supported section types.ResourceGroupDefinition.Section Supported section types. -
Annotation Types Summary Annotation Type Description Author Denotes the author of the generated REST-based microservice documentation.Author.List Defines severalAuthorannotations on the same element.BaseEndpoint Denotes the basic endpoint in the generated REST-based microservice documentation.Description Denotes the description of the generated REST-based microservice documentation.DocumentationDefinition A composite annotation that specifies the settings for generating a whole document.DocumentationVersion Denotes the version of REST-based microservice in the generated REST-based microservice documentation.Example Denotes the model field value used as an example in the generated REST-based microservice documentation.Example.List Defines severalExampleannotations on the same element.IncludeDescription Denotes the AsciiDoc fragment to be imported into the generated REST-based microservice documentation.IntroductionDefinition A composite annotation that specifies the settings for generating the Introduction section.License Denotes the license of REST-based microservice in the generated REST-based microservice documentation.License.List Defines severalLicenseannotations on the same element.ModelExceptionErrorResponse Denotes the exception class to be analyzed by theRxMicro Annotation Processorfor generating the unsuccessful HTTP response description of REST-based microservice.ModelExceptionErrorResponse.List Defines severalModelExceptionErrorResponseannotations on the same element.ResourceDefinition A composite annotation that specifies the settings for generating the ResourceDefinition section.ResourceGroupDefinition A composite annotation that specifies the settings for generating the ResourceGroupDefinition section.SimpleErrorResponse Contains metadata about the unsuccessful HTTP response of REST-based microservice.SimpleErrorResponse.List Defines severalSimpleErrorResponseannotations on the same element.Title Denotes the name of the generated REST-based microservice documentation.