Package act.apidoc

Interface Summary

Interface	Description
EndpointIdProvider
ISampleDataCategory	Identify a sample data category

Class Summary

Class	Description
ApiDocCompileContext
ApiManager	Keep track endpoints defined in the system
Endpoint	An Endpoint represents an API that provides specific service
Endpoint.ParamInfo
SampleData	Namespace
SampleDataCategoryManager
SampleDataProvider<T>
SampleDataProviderFinder
SampleDataProviderManager
SimpleEndpointIdProvider

Enum Summary

Enum	Description
Endpoint.Scheme	The scheme defines the protocol used to access the endpoint
SampleDataCategory

Annotation Types Summary

Annotation Type	Description
Description	The @Description annotation can be used by developer to document programming elements including class, field, method and parameter.
Module	The @Module annotation can be used by developer to mark a class’s module, which will be used to organise the API book.
SampleData.Category	Mark on an implementation class of SampleDataProvider to specify the sample data category the provider applied
SampleData.DoubleList	Mark on a field specify the list of double that can be randomly choosen as sample data for the field
SampleData.IntList	Mark on a field specify the list of integer that can be randomly choosen as sample data for the field
SampleData.Locale	Mark on an implementation class of SampleDataProvider to specify the sample data locale the provider applied
SampleData.ProvidedBy	Mark on a field specify the SampleDataProvider that should be used to generate sample data for the field been marked
SampleData.StringList	Mark on a field specify the list of string that can be randomly choosen as sample data for the field