Package com.linecorp.armeria.server.docs
Documentation service.
-
Interface Summary Interface Description DocServicePlugin Generates theServiceSpecification
s of the supportedService
s.NamedTypeInfo Metadata about a named type. -
Class Summary Class Description DocService DocServiceBuilder Builds a newDocService
.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 aService
.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.MethodInfo Metadata about a function of aService
.ServiceInfo Metadata about aService
.ServiceSpecification StructInfo Metadata about a struct type.TypeSignature Type signature of a method parameter, a method return value or a struct/exception field.TypeSignatureJsonSerializer JacksonJsonSerializer
forTypeSignature
. -
Enum Summary Enum Description FieldRequirement The requirement level of a field.