Index (mirage-api-detector 0.0.3 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.mirage.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.mirage.MirageApiDetectorPlugin

C

collect(File) - Method in class com.arc_e_tect.gradle.mirage.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.mirage - package com.arc_e_tect.gradle.mirage
com.arc_e_tect.gradle.mirage.detect - package com.arc_e_tect.gradle.mirage.detect
com.arc_e_tect.gradle.mirage.model - package com.arc_e_tect.gradle.mirage.model
com.arc_e_tect.gradle.mirage.openapi - package com.arc_e_tect.gradle.mirage.openapi
com.arc_e_tect.gradle.mirage.report - package com.arc_e_tect.gradle.mirage.report
com.arc_e_tect.gradle.mirage.scan - package com.arc_e_tect.gradle.mirage.scan
ControllerScanner - Class in com.arc_e_tect.gradle.mirage.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.mirage.scan.ControllerScanner: Creates a new ControllerScanner.

D

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

E

Endpoint - Record Class in com.arc_e_tect.gradle.mirage.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.mirage.model.Endpoint: Creates an instance of a Endpoint record class.
equals(Object) - Method in record class com.arc_e_tect.gradle.mirage.model.Endpoint: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.arc_e_tect.gradle.mirage.openapi.DescribedEndpoint: Indicates whether some other object is "equal to" this one.

F

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

G

generate() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Task action: loads the configured OpenAPI documentation, scans the configured controller directories, writes the mirage API report, and - when DetectMirageApisTask.getFailOnMirage() is true - fails the build if any mirage API was found.
GET - Enum constant in enum class com.arc_e_tect.gradle.mirage.model.HttpVerb
getControllerDirs() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Directories to search recursively for @RestController classes.
getControllerDirs() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Directories to search recursively for @RestController classes, used to determine which OpenAPI operations are implemented.
getFailOnMirage() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Whether the build should fail when mirage APIs are found.
getFailOnMirage() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Whether the build should fail when mirage APIs are found.
getOpenApiDir() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Directory where OpenAPI descriptions are stored, tracked so that changes to any document reachable from DetectMirageApisTask.getRootDocument() invalidate the task's cached result.
getOpenApiDir() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Directory where OpenAPI descriptions are stored.
getReportDir() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Directory the AsciiDoc report is written to.
getReportDir() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Directory the AsciiDoc report is written to.
getReportFileName() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Name of the generated AsciiDoc report file (without path).
getReportFileName() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Name of the generated AsciiDoc report file (without path).
getRootDocument() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: The root OpenAPI document describing the API.
getRootDocument() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: The root OpenAPI document describing the API.
getSystemUnderTestVersion() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: 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.mirage.MirageApiDetectorExtension: 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.mirage.model.Endpoint: Returns a hash code value for this object.
hashCode() - Method in record class com.arc_e_tect.gradle.mirage.openapi.DescribedEndpoint: Returns a hash code value for this object.
HEAD - Enum constant in enum class com.arc_e_tect.gradle.mirage.model.HttpVerb
HttpVerb - Enum Class in com.arc_e_tect.gradle.mirage.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.mirage.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.mirage.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.mirage.model.Endpoint: Returns the value of the lineNumber record component.

M

matches(String, String) - Static method in class com.arc_e_tect.gradle.mirage.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.mirage.model.Endpoint: Returns the value of the methodSignature record component.
MirageApiDetectorExtension - Class in com.arc_e_tect.gradle.mirage: DSL extension for the Mirage API Detector Gradle plugin.
MirageApiDetectorExtension() - Constructor for class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: For use by the Gradle-generated concrete subclass.
MirageApiDetectorPlugin - Class in com.arc_e_tect.gradle.mirage: Gradle plugin that registers the detectMirageApis task and wires the mirageApiDetector DSL extension into the project.
MirageApiDetectorPlugin() - Constructor for class com.arc_e_tect.gradle.mirage.MirageApiDetectorPlugin: Creates a new plugin instance.
MirageApiFinder - Class in com.arc_e_tect.gradle.mirage.detect: Determines which DescribedEndpoints collected from the OpenAPI documentation have no matching controller Endpoint, i.e.
MirageApiFinder() - Constructor for class com.arc_e_tect.gradle.mirage.detect.MirageApiFinder: Creates a new MirageApiFinder.
MirageApiReportWriter - Class in com.arc_e_tect.gradle.mirage.report: Writes the AsciiDoc mirage API report: every OpenAPI operation that has no matching @RestController implementation.
MirageApiReportWriter() - Constructor for class com.arc_e_tect.gradle.mirage.report.MirageApiReportWriter: Creates a new MirageApiReportWriter.

N

NAME - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Extension DSL block name, i.e.
normalize(String) - Static method in class com.arc_e_tect.gradle.mirage.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.mirage.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.mirage.openapi.OpenApiEndpointCollector: Creates a new OpenApiEndpointCollector.
operationId() - Method in record class com.arc_e_tect.gradle.mirage.openapi.DescribedEndpoint: Returns the value of the operationId record component.
OPTIONS - Enum constant in enum class com.arc_e_tect.gradle.mirage.model.HttpVerb

P

PATCH - Enum constant in enum class com.arc_e_tect.gradle.mirage.model.HttpVerb
path() - Method in record class com.arc_e_tect.gradle.mirage.model.Endpoint: Returns the value of the path record component.
path() - Method in record class com.arc_e_tect.gradle.mirage.openapi.DescribedEndpoint: Returns the value of the path record component.
PathMatcher - Class in com.arc_e_tect.gradle.mirage.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.mirage.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.mirage.model.HttpVerb
PUT - Enum constant in enum class com.arc_e_tect.gradle.mirage.model.HttpVerb

S

scan(File) - Method in class com.arc_e_tect.gradle.mirage.scan.ControllerScanner: Scans one .java source file and returns every endpoint exposed by every @RestController class it declares.
sourceFile() - Method in record class com.arc_e_tect.gradle.mirage.model.Endpoint: Returns the value of the sourceFile record component.

T

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

U

Usage - Search tag in class com.arc_e_tect.gradle.mirage.MirageApiDetectorPlugin: Section

V

valueOf(String) - Static method in enum class com.arc_e_tect.gradle.mirage.model.HttpVerb: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.arc_e_tect.gradle.mirage.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.mirage.model.Endpoint: Returns the value of the verb record component.
verb() - Method in record class com.arc_e_tect.gradle.mirage.openapi.DescribedEndpoint: Returns the value of the verb record component.

W

write(File, int, List<DescribedEndpoint>, String) - Method in class com.arc_e_tect.gradle.mirage.report.MirageApiReportWriter: 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