Index (shadow-api-detector 1.0.0 API)

A C D E F G H I J L M N O P S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

ANY - Enum constant in enum class com.arc_e_tect.gradle.shadow.model.HttpVerb: Matches any concrete verb; used for Spring mappings that do not restrict the verb.
apply(Project) - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorPlugin

C

collect(File) - Method in class com.arc_e_tect.gradle.shadow.openapi.OpenApiEndpointCollector: Parses rootDocument and every document it links to (relative $refs are resolved automatically), and returns the verb + path template pair described by every operation found.
com.arc_e_tect.gradle.shadow - package com.arc_e_tect.gradle.shadow
com.arc_e_tect.gradle.shadow.detect - package com.arc_e_tect.gradle.shadow.detect
com.arc_e_tect.gradle.shadow.model - package com.arc_e_tect.gradle.shadow.model
com.arc_e_tect.gradle.shadow.openapi - package com.arc_e_tect.gradle.shadow.openapi
com.arc_e_tect.gradle.shadow.report - package com.arc_e_tect.gradle.shadow.report
com.arc_e_tect.gradle.shadow.scan - package com.arc_e_tect.gradle.shadow.scan
ControllerScanner - Class in com.arc_e_tect.gradle.shadow.scan: Parses Java source files and collects every HTTP endpoint exposed by a Spring @RestController class.
ControllerScanner() - Constructor for class com.arc_e_tect.gradle.shadow.scan.ControllerScanner: Creates a new ControllerScanner.

D

declaringClass() - Method in record class com.arc_e_tect.gradle.shadow.model.Endpoint: Returns the value of the declaringClass record component.
DEFAULT_CONTROLLER_DIR - Static variable in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Default relative path of the directory searched for @RestController classes.
DEFAULT_REPORT_FILE_NAME - Static variable in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Default name of the generated AsciiDoc report file.
Defaults - Search tag in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorPlugin: Section
DELETE - Enum constant in enum class com.arc_e_tect.gradle.shadow.model.HttpVerb
DescribedEndpoint - Record Class in com.arc_e_tect.gradle.shadow.openapi: A single HTTP verb + path template pair described by an OpenAPI operation.
DescribedEndpoint(HttpVerb, String) - Constructor for record class com.arc_e_tect.gradle.shadow.openapi.DescribedEndpoint: Creates an instance of a DescribedEndpoint record class.
DetectShadowApisTask - Class in com.arc_e_tect.gradle.shadow: 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".
DetectShadowApisTask() - Constructor for class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Creates the task.

E

Endpoint - Record Class in com.arc_e_tect.gradle.shadow.model: A single HTTP endpoint exposed by a @RestController method, as found by scanning controller source code.
Endpoint(HttpVerb, String, String, String, String, int) - Constructor for record class com.arc_e_tect.gradle.shadow.model.Endpoint: Creates an instance of a Endpoint record class.
equals(Object) - Method in record class com.arc_e_tect.gradle.shadow.model.Endpoint: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.arc_e_tect.gradle.shadow.openapi.DescribedEndpoint: Indicates whether some other object is "equal to" this one.

F

findShadows(List<Endpoint>, List<DescribedEndpoint>) - Method in class com.arc_e_tect.gradle.shadow.detect.ShadowApiFinder: Returns every endpoint in endpoints that has no matching entry in described.
fromSpringRequestMethod(String) - Static method in enum class com.arc_e_tect.gradle.shadow.model.HttpVerb: Resolves the HttpVerb matching a Spring RequestMethod enum constant name (e.g.

G

generate() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Task action: scans the configured controller directories, loads the configured OpenAPI documentation, writes the shadow API report, and - when DetectShadowApisTask.getFailOnShadow() is true - fails the build if any shadow API was found.
GET - Enum constant in enum class com.arc_e_tect.gradle.shadow.model.HttpVerb
getControllerDirs() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Directories to search recursively for @RestController classes.
getControllerDirs() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Directories to search recursively for @RestController classes.
getFailOnShadow() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Whether the build should fail when shadow APIs are found.
getFailOnShadow() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Whether the build should fail when shadow APIs are found.
getOpenApiDir() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Directory where OpenAPI descriptions are stored, tracked so that changes to any document reachable from DetectShadowApisTask.getRootDocument() invalidate the task's cached result.
getOpenApiDir() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Directory where OpenAPI descriptions are stored.
getReportDir() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Directory the AsciiDoc report is written to.
getReportDir() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Directory the AsciiDoc report is written to.
getReportFileName() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Name of the generated AsciiDoc report file (without path).
getReportFileName() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Name of the generated AsciiDoc report file (without path).
getRootDocument() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: The root OpenAPI document describing the API.
getRootDocument() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: The root OpenAPI document describing the API.
getSystemUnderTestVersion() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Version of the system under test whose @RestController classes were scanned, printed in the generated report as e.g.
getSystemUnderTestVersion() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Version of the system under test whose @RestController classes are scanned, printed in the generated report as e.g.

H

hashCode() - Method in record class com.arc_e_tect.gradle.shadow.model.Endpoint: Returns a hash code value for this object.
hashCode() - Method in record class com.arc_e_tect.gradle.shadow.openapi.DescribedEndpoint: Returns a hash code value for this object.
HEAD - Enum constant in enum class com.arc_e_tect.gradle.shadow.model.HttpVerb
HttpVerb - Enum Class in com.arc_e_tect.gradle.shadow.model: HTTP verb exposed by a Spring MVC endpoint or described by an OpenAPI operation.

I

isPlaceholder(String) - Static method in class com.arc_e_tect.gradle.shadow.model.PathTemplates: Returns whether segment is a Spring/OpenAPI path-variable placeholder, i.e.

J

join(String, String) - Static method in class com.arc_e_tect.gradle.shadow.model.PathTemplates: Joins a base path and a sub-path into a single normalised path template.

L

lineNumber() - Method in record class com.arc_e_tect.gradle.shadow.model.Endpoint: Returns the value of the lineNumber record component.

M

matches(String, String) - Static method in class com.arc_e_tect.gradle.shadow.model.PathMatcher: Returns whether two normalised path templates are structurally equivalent: same number of "/"-delimited segments, with every literal segment equal and every placeholder segment (e.g.
methodSignature() - Method in record class com.arc_e_tect.gradle.shadow.model.Endpoint: Returns the value of the methodSignature record component.

N

NAME - Static variable in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Extension DSL block name, i.e.
normalize(String) - Static method in class com.arc_e_tect.gradle.shadow.model.PathTemplates: Normalises a path template: ensures a leading "/", collapses repeated "/" separators, strips path-variable regex constraints (e.g.

O

OpenApiEndpointCollector - Class in com.arc_e_tect.gradle.shadow.openapi: Loads a root OpenAPI document - resolving every $ref to other documents relative to it - and collects every HTTP verb + path template pair it describes.
OpenApiEndpointCollector() - Constructor for class com.arc_e_tect.gradle.shadow.openapi.OpenApiEndpointCollector: Creates a new OpenApiEndpointCollector.
OPTIONS - Enum constant in enum class com.arc_e_tect.gradle.shadow.model.HttpVerb

P

PATCH - Enum constant in enum class com.arc_e_tect.gradle.shadow.model.HttpVerb
path() - Method in record class com.arc_e_tect.gradle.shadow.model.Endpoint: Returns the value of the path record component.
path() - Method in record class com.arc_e_tect.gradle.shadow.openapi.DescribedEndpoint: Returns the value of the path record component.
PathMatcher - Class in com.arc_e_tect.gradle.shadow.model: Compares two normalised path templates for structural equivalence, tolerant of path-variable naming differences (e.g.
PathTemplates - Class in com.arc_e_tect.gradle.shadow.model: Utility methods for normalising and combining Spring MVC / OpenAPI path templates so that they can be compared regardless of superficial formatting differences.
POST - Enum constant in enum class com.arc_e_tect.gradle.shadow.model.HttpVerb
PUT - Enum constant in enum class com.arc_e_tect.gradle.shadow.model.HttpVerb

S

scan(File) - Method in class com.arc_e_tect.gradle.shadow.scan.ControllerScanner: Scans one .java source file and returns every endpoint exposed by every @RestController class it declares.
ShadowApiDetectorExtension - Class in com.arc_e_tect.gradle.shadow: DSL extension for the Shadow API Detector Gradle plugin.
ShadowApiDetectorExtension() - Constructor for class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: For use by the Gradle-generated concrete subclass.
ShadowApiDetectorPlugin - Class in com.arc_e_tect.gradle.shadow: Gradle plugin that registers the detectShadowApis task and wires the shadowApiDetector DSL extension into the project.
ShadowApiDetectorPlugin() - Constructor for class com.arc_e_tect.gradle.shadow.ShadowApiDetectorPlugin: Creates a new plugin instance.
ShadowApiFinder - Class in com.arc_e_tect.gradle.shadow.detect: Determines which controller Endpoints are not described by any DescribedEndpoint collected from the OpenAPI documentation, i.e.
ShadowApiFinder() - Constructor for class com.arc_e_tect.gradle.shadow.detect.ShadowApiFinder: Creates a new ShadowApiFinder.
ShadowApiReportWriter - Class in com.arc_e_tect.gradle.shadow.report: Writes the AsciiDoc shadow API report: every @RestController endpoint that is not described in the configured OpenAPI documentation.
ShadowApiReportWriter() - Constructor for class com.arc_e_tect.gradle.shadow.report.ShadowApiReportWriter: Creates a new ShadowApiReportWriter.
sourceFile() - Method in record class com.arc_e_tect.gradle.shadow.model.Endpoint: Returns the value of the sourceFile record component.

T

TASK_NAME - Static variable in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorPlugin: Name of the Gradle task registered by this plugin.
toString() - Method in record class com.arc_e_tect.gradle.shadow.model.Endpoint: Returns a string representation of this record class.
toString() - Method in record class com.arc_e_tect.gradle.shadow.openapi.DescribedEndpoint: Returns a string representation of this record class.
TRACE - Enum constant in enum class com.arc_e_tect.gradle.shadow.model.HttpVerb

U

Usage - Search tag in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorPlugin: Section

V

valueOf(String) - Static method in enum class com.arc_e_tect.gradle.shadow.model.HttpVerb: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.arc_e_tect.gradle.shadow.model.HttpVerb: Returns an array containing the constants of this enum class, in the order they are declared.
verb() - Method in record class com.arc_e_tect.gradle.shadow.model.Endpoint: Returns the value of the verb record component.
verb() - Method in record class com.arc_e_tect.gradle.shadow.openapi.DescribedEndpoint: Returns the value of the verb record component.

W

write(File, int, List<Endpoint>, String) - Method in class com.arc_e_tect.gradle.shadow.report.ShadowApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.

A C D E F G H I J L M N O P S T U V W
All Classes and Interfaces|All Packages|Constant Field Values