Constructor Detail

• OpenApiOptions

  OpenApiOptions(Info info)

• OpenApiOptions

  OpenApiOptions(InitialConfigurationCreator initialConfigurationCreator)

Method Detail

• getPath

   final String getPath()

  If not null, creates a GET route to get the schema as a json

• setPath

   final Unit setPath(String path)

  If not null, creates a GET route to get the schema as a json

• getRoles

   final Set<RouteRole> getRoles()

• setRoles

   final Unit setRoles(Set<RouteRole> roles)

• getSwagger

   final SwaggerOptions getSwagger()

  If not null, creates a GET route to the swagger ui

• setSwagger

   final Unit setSwagger(SwaggerOptions swagger)

  If not null, creates a GET route to the swagger ui

• getReDoc

   final ReDocOptions getReDoc()

  If not null, creates a GET route to the reDoc ui

• setReDoc

   final Unit setReDoc(ReDocOptions reDoc)

  If not null, creates a GET route to the reDoc ui

• getDefault

   final DefaultDocumentation getDefault()

  Function that is applied to every new operation. You can use this to set defaults (like a 500 response).

• setDefault

   final Unit setDefault(DefaultDocumentation default)

  Function that is applied to every new operation. You can use this to set defaults (like a 500 response).

• getJacksonMapper

   final ObjectMapper getJacksonMapper()

  The default jackson mapper used, for "modelConverterFactory" and "toJsonMapper" if not overridden.

• setJacksonMapper

   final Unit setJacksonMapper(ObjectMapper jacksonMapper)

  The default jackson mapper used, for "modelConverterFactory" and "toJsonMapper" if not overridden.

• getModelConverterFactory

   final ModelConverterFactory getModelConverterFactory()

  Creates a model converter, which converts a class to an open api schema. Defaults to the jackson converter.

• setModelConverterFactory

   final Unit setModelConverterFactory(ModelConverterFactory modelConverterFactory)

  Creates a model converter, which converts a class to an open api schema. Defaults to the jackson converter.

• getToJsonMapper

   final ToJsonMapper getToJsonMapper()

  The json mapper for creating the object api schema json. This is separated from the default JavalinJson mappers.

• setToJsonMapper

   final Unit setToJsonMapper(ToJsonMapper toJsonMapper)

  The json mapper for creating the object api schema json. This is separated from the default JavalinJson mappers.

• getResponseModifier

   final OpenApiModelModifier getResponseModifier()

  Function that allows modification of the OpenAPI model before it is sent to the client. Since the OpenAPI model is mutable, care should be taken to make sure any modifications are idempotent. If this is not possible, caching of the model may be disabled, but this incurs a performance penalty.

• setResponseModifier

   final Unit setResponseModifier(OpenApiModelModifier responseModifier)

  Function that allows modification of the OpenAPI model before it is sent to the client. Since the OpenAPI model is mutable, care should be taken to make sure any modifications are idempotent. If this is not possible, caching of the model may be disabled, but this incurs a performance penalty.

• getPackagePrefixesToScan

   final Set<String> getPackagePrefixesToScan()

  A list of package prefixes to scan for annotations.

• setPackagePrefixesToScan

   final Unit setPackagePrefixesToScan(Set<String> packagePrefixesToScan)

  A list of package prefixes to scan for annotations.

• getOverriddenDocumentation

   final List<HandlerMetaInfo> getOverriddenDocumentation()

  Manual set the documentation of specific paths

• setOverriddenDocumentation

   final Unit setOverriddenDocumentation(List<HandlerMetaInfo> overriddenDocumentation)

  Manual set the documentation of specific paths

• getIgnoredPaths

   final List<Pair<String, List<HttpMethod>>> getIgnoredPaths()

  A list of paths to ignore in documentation

• setIgnoredPaths

   final Unit setIgnoredPaths(List<Pair<String, List<HttpMethod>>> ignoredPaths)

  A list of paths to ignore in documentation

• getIncludedPaths

   final List<Pair<String, List<HttpMethod>>> getIncludedPaths()

  A list of the only paths which will be considered as part of the OpenAPI documentation. If this list is empty it will be considered as meaning that all paths should be included with the exception of the ignored paths

• getValidateSchema

   final Boolean getValidateSchema()

  Validate the generated schema with the swagger parser (prints warnings if schema is invalid)

• setValidateSchema

   final Unit setValidateSchema(Boolean validateSchema)

  Validate the generated schema with the swagger parser (prints warnings if schema is invalid)

• getCacheSchema

   final Boolean getCacheSchema()

  Flag indicating whether or not the generated schema should be cached. Caching is enabled by default.

• setCacheSchema

   final Unit setCacheSchema(Boolean cacheSchema)

  Flag indicating whether or not the generated schema should be cached. Caching is enabled by default.

• getInitialConfigurationCreator

   final InitialConfigurationCreator getInitialConfigurationCreator()

• path

   final OpenApiOptions path(String value)

• disableCaching

   final OpenApiOptions disableCaching()

• responseModifier

   final OpenApiOptions responseModifier(OpenApiModelModifier value)

• swagger

   final OpenApiOptions swagger(SwaggerOptions value)

• reDoc

   final OpenApiOptions reDoc(ReDocOptions value)

• roles

   final OpenApiOptions roles(RouteRole value)

• defaultDocumentation

   final OpenApiOptions defaultDocumentation(DefaultDocumentation value)

• defaultDocumentation

   final OpenApiOptions defaultDocumentation(Function1<OpenApiDocumentation, Unit> apply)

• examples

   final Unit examples(Map<Class<?>, Map<String, Example>> examples)

• addExample

   final <T extends Any> Unit addExample(Class<T> clazz, String name, Example example)

• activateAnnotationScanningFor

   final OpenApiOptions activateAnnotationScanningFor(String packagePrefixes)

  Activate annotation scanning for specific package prefixes. This will search for OpenApi annotations which define the path and method * property. If an handler with the same path and method is added and the handler doesn't have any documentation or the documentation cannot be accessed by reflection, the annotation will be used. Currently this is just required for java method references.

• jacksonMapper

   final OpenApiOptions jacksonMapper(ObjectMapper value)

• modelConverterFactory

   final OpenApiOptions modelConverterFactory(ModelConverterFactory value)

• toJsonMapper

   final OpenApiOptions toJsonMapper(ToJsonMapper value)

• getFullDocumentationUrl

   final String getFullDocumentationUrl(Context ctx)

• setDocumentation

   final OpenApiOptions setDocumentation(String path, HttpMethod method, OpenApiDocumentation documentation)

• validateSchema

   final OpenApiOptions validateSchema(Boolean validate)

• ignorePath

   final OpenApiOptions ignorePath(String path, HttpMethod httpMethod)

• includePath

   final OpenApiOptions includePath(String path, HttpMethod httpMethod)

  adds the given path and methods to the list of paths which should be scanned by OpenAPI

  Parameters:

  path - : the path to include in the paths to scan

  httpMethod - : the list of http methods to include in the scan (as a vararg)