com.holonplatform.jaxrs.swagger

Interface ApiReader<M>

Type Parameters:

M - API model type

public interface ApiReader<M>

API definitions reader.

Since:

5.2.0

Method Summary

Modifier and Type	Method and Description
default M	read(Class<?>... classes) Read the given API resource class set and build the API definition model.
M	read(Set<Class<?>> classes) Read the given API resource class set and build the API definition model.

Method Detail

read

M read(Set<Class<?>> classes)
throws ApiConfigurationException

Read the given API resource class set and build the API definition model.

Parameters:

classes - The API resource classes from which to create the API definition model

Returns:

The API definition model

Throws:

ApiConfigurationException - If an error occurred

read

default M read(Class<?>... classes)
        throws ApiConfigurationException

Read the given API resource class set and build the API definition model.

Parameters:

classes - The API resource classes from which to create the API definition model

Returns:

The API definition model

Throws:

ApiConfigurationException - If an error occurred