@NonNullByDefault

Package com.linecorp.armeria.server.docs

Documentation service.

Interface Summary

Interface	Description
DocServiceFilter	A filter which includes or excludes service methods when building a DocService.
DocServicePlugin	Generates the ServiceSpecifications of the supported Services.
NamedTypeInfo	Metadata about a named type.

Class Summary

Class	Description
DocService	An HttpService that provides information about the Services running in a Server.
DocServiceBuilder	Builds a new DocService.
DocStringExtractor	A supporting base class for implementing the standard pattern of extracting docstrings from arbitrary files in a particular classpath location.
EndpointInfo	Metadata about the endpoints exposed by a Service.
EndpointInfoBuilder	Creates a new EndpointInfo using the builder pattern.
EnumInfo	Metadata about an enum type.
EnumValueInfo	Metadata about an enum value.
ExceptionInfo	Metadata about an exception type.
FieldInfo	Metadata about a field of a struct or an exception.
FieldInfoBuilder	Creates a new FieldInfo using the builder pattern.
MethodInfo	Metadata about a function of a Service.
ServiceInfo	Metadata about a Service.
ServiceSpecification	The specification of one or more Services that provides their ServiceInfos and NamedTypeInfos.
StructInfo	Metadata about a struct type.
TypeSignature	Type signature of a method parameter, a method return value or a struct/exception field.

Enum Summary

Enum	Description
FieldLocation	The location of a field.
FieldRequirement	The requirement level of a field.