Class ApiAwareMiddlewareVersionV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractMiddlewareVersion

com.kingsrook.qqq.middleware.javalin.specs.v1.MiddlewareVersionV1

com.kingsrook.qqq.api.middleware.specs.v1.ApiAwareMiddlewareVersionV1

public class ApiAwareMiddlewareVersionV1
extends MiddlewareVersionV1

Field Summary

Fields inherited from class com.kingsrook.qqq.middleware.javalin.specs.v1.MiddlewareVersionV1

FEATURES, SEMANTIC_VERSION

Fields inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractMiddlewareVersion

LOG

Constructor Summary

Constructors

Constructor	Description
ApiAwareMiddlewareVersionV1()	Constructor

Method Summary

Modifier and Type	Method	Description
void	addVersion(String apiName, APIVersion apiVersion)
List<AbstractEndpointSpec<?,?,?>>	defineEndpointSpecs()
List<String>	getDocumentationBasePaths()	Documentation belongs only to registered API paths and versions.
List<AbstractEndpointSpec<?,?,?>>	getEndpointSpecs()	hey - don't re-construct the endpoint-spec objects inside this method...
String	getVersionBasePath()
void	preExecute(io.javalin.http.Context context)

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.v1.MiddlewareVersionV1

getFeatures, getSemanticVersion, getVersion

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractMiddlewareVersion

generateExtensionOpenAPIModel, generateOpenAPIModel, getAllEndpointSpecs, getExtensions, getJavalinEndpointGroup, loadExtensions, setQInstance, warnIfPathMethodAlreadyUsed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ApiAwareMiddlewareVersionV1

public ApiAwareMiddlewareVersionV1()

Constructor

Method Details

addVersion

public void addVersion(String apiName,
 APIVersion apiVersion)

defineEndpointSpecs

public List<AbstractEndpointSpec<?,?,?>> defineEndpointSpecs()

getEndpointSpecs

public List<AbstractEndpointSpec<?,?,?>> getEndpointSpecs()

Description copied from class: AbstractMiddlewareVersion

hey - don't re-construct the endpoint-spec objects inside this method...

Overrides:

getEndpointSpecs in class MiddlewareVersionV1

getVersionBasePath

public String getVersionBasePath()

Overrides:

getVersionBasePath in class AbstractMiddlewareVersion

getDocumentationBasePaths

public List<String> getDocumentationBasePaths()

Documentation belongs only to registered API paths and versions. The generic execution path would otherwise capture routes such as esb/overview.

Overrides:

getDocumentationBasePaths in class AbstractMiddlewareVersion

preExecute

public void preExecute(io.javalin.http.Context context)
                throws QException

Overrides:

preExecute in class AbstractMiddlewareVersion

Throws:

QException