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 scans
@RestController classes, compares the endpoints they expose
against the configured OpenAPI documentation, and writes an AsciiDoc report of every endpoint
that is not described - the "shadow 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.
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.
DSL extension for the Shadow API Detector Gradle plugin.
Gradle plugin that registers the
detectShadowApis task and wires the
shadowApiDetector DSL extension into the project.Determines which controller
Endpoints are not described by any DescribedEndpoint
collected from the OpenAPI documentation, i.e.Writes the AsciiDoc shadow API report: every
@RestController endpoint that is not
described in the configured OpenAPI documentation.