Class UiApiRouteAuditor

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.UiApiRouteAuditor

public class UiApiRouteAuditor
extends Object

Finds HTTP routes bound under a UI API version's base path (e.g. /qqq/v1) that no endpoint spec describes - raw handlers that a non-web client could not discover from the OpenAPI document. QApplicationJavalinServer runs it after building the service: by default it logs a warning per route; in strict mode it fails startup. See docs/UI-API-EXTENSIONS.md.

Constructor Summary

Constructors

Constructor	Description
UiApiRouteAuditor()

Method Summary

Modifier and Type	Method	Description
static void	audit(io.javalin.Javalin service, List<AbstractMiddlewareVersion> versions, boolean strict)	Audit a service: warn about each unspecified route, or throw if strict.
static List<String>	findUnspecifiedRoutes(io.javalin.Javalin service, List<AbstractMiddlewareVersion> versions)	The routes (as "METHOD /path") under the versions' base paths that no spec describes.

Methods inherited from class java.lang.Object

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

Constructor Details

UiApiRouteAuditor

public UiApiRouteAuditor()

Method Details

findUnspecifiedRoutes

public static List<String> findUnspecifiedRoutes(io.javalin.Javalin service,
 List<AbstractMiddlewareVersion> versions)

The routes (as "METHOD /path") under the versions' base paths that no spec describes.

audit

public static void audit(io.javalin.Javalin service,
 List<AbstractMiddlewareVersion> versions,
 boolean strict)

Audit a service: warn about each unspecified route, or throw if strict.