All Classes and Interfaces
Class
Description
Parses Java source files and collects every HTTP endpoint exposed by a Spring
@RestController class.A single HTTP verb + path template pair described by an OpenAPI operation.
Gradle task that parses the configured OpenAPI documentation, compares the operations it
describes against the endpoints exposed by scanned
@RestController classes, and writes
an AsciiDoc report of every operation that has no matching implementation - the "mirage APIs".A single HTTP endpoint exposed by a
@RestController method, as found by scanning
controller source code.HTTP verb exposed by a Spring MVC endpoint or described by an OpenAPI operation.
DSL extension for the Mirage API Detector Gradle plugin.
Gradle plugin that registers the
detectMirageApis task and wires the
mirageApiDetector DSL extension into the project.Determines which
DescribedEndpoints collected from the OpenAPI documentation have no
matching controller Endpoint, i.e.Writes the AsciiDoc mirage API report: every OpenAPI operation that has no matching
@RestController implementation.Loads a root OpenAPI document - resolving every
$ref to other documents relative to
it - and collects every HTTP verb + path template pair it describes.Compares two normalised path templates for structural equivalence, tolerant of path-variable
naming differences (e.g.
Utility methods for normalising and combining Spring MVC / OpenAPI path templates so that
they can be compared regardless of superficial formatting differences.