Index (mirage-api-detector 0.4.0 API)

A C D F G M N S T U W
All Classes and Interfaces|All Packages|Constant Field Values

A

apply(Project) - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorPlugin

C

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.report - package com.arc_e_tect.gradle.mirage.report
com.arc_e_tect.gradle.mirage.scan - package com.arc_e_tect.gradle.mirage.scan

D

DEFAULT_CONTRACT_HISTORY_FILE_NAME - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Default name of the persisted contract progress history file.
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.
DEFAULT_STUB_DIR - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Default relative path of the directory searched for WireMock stub mapping files.
Defaults - Search tag in class com.arc_e_tect.gradle.mirage.MirageApiDetectorPlugin: Section
DetectMirageApisTask - Class in com.arc_e_tect.gradle.mirage: Gradle task that parses the configured OpenAPI documentation, compares the operations it describes against a set of implemented endpoints, and writes an AsciiDoc report of every operation that has no match - the "mirage APIs".
DetectMirageApisTask() - Constructor for class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Creates the task.

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.

G

generate() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Task action: loads the configured OpenAPI documentation, scans either the configured controller directories or WireMock stub directories (per DetectMirageApisTask.getScanMocks()), writes the mirage API report, and - when DetectMirageApisTask.getFailOnMirage() is true - fails the build if any mirage API was found.
getContractHistoryFile() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: File that the persisted contract progress history is read from and, when DetectMirageApisTask.getUpdateContractHistory() is true, written back to.
getContractHistoryFile() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: File that the persisted contract progress history is read from and, when MirageApiDetectorExtension.getUpdateContractHistory() is true, written back to.
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.
getScanMocks() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Whether to determine implemented endpoints from WireMock stub mapping files under DetectMirageApisTask.getStubDirs() instead of scanning @RestController classes.
getScanMocks() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Whether to determine implemented endpoints from WireMock stub mapping files under MirageApiDetectorExtension.getStubDirs() instead of scanning @RestController classes under MirageApiDetectorExtension.getControllerDirs().
getStubDirs() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Directories to search recursively for WireMock stub mapping files, used to determine implemented endpoints when DetectMirageApisTask.getScanMocks() is true.
getStubDirs() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Directories to search recursively for WireMock stub mapping files (*.json), used to determine implemented endpoints when MirageApiDetectorExtension.getScanMocks() is true.
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.
getTrackContractHistory() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Whether to persist, across builds, a history of when each endpoint first reached each stage of its contract lifecycle - declared, implemented, verified.
getTrackContractHistory() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Whether to persist, across builds, a history of when each endpoint first reached each stage of its contract lifecycle - declared, implemented, verified - keyed by a fingerprint of its HTTP verb and path so the history is shared correctly with Shadow and Doppelganger API Detector when they're pointed at the same MirageApiDetectorExtension.getContractHistoryFile().
getUpdateContractHistory() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Whether DetectMirageApisTask.getContractHistoryFile() is written back to disk after being updated with the current run's endpoints.
getUpdateContractHistory() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Whether MirageApiDetectorExtension.getContractHistoryFile() is written back to disk after being updated with the current run's endpoints.

M

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.

S

scan(File) - Method in class com.arc_e_tect.gradle.mirage.scan.WireMockStubScanner: Scans every .json file under rootDir, recursively, for the stubbed method and URL.

T

TASK_NAME - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorPlugin: Name of the Gradle task registered by this plugin.

U

UPDATE_CONTRACT_HISTORY_OVERRIDE_PROPERTY - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Name of the Gradle project property that overrides MirageApiDetectorExtension.getUpdateContractHistory() from the command line for every project in the build, e.g.
Usage - Search tag in class com.arc_e_tect.gradle.mirage.MirageApiDetectorPlugin: Section

W

WireMockStubScanner - Class in com.arc_e_tect.gradle.mirage.scan: Scans WireMock stub mapping files (*.json) for the request each one stubs, treating every stubbed request as an implemented endpoint.
WireMockStubScanner() - Constructor for class com.arc_e_tect.gradle.mirage.scan.WireMockStubScanner: Creates a new WireMockStubScanner.
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.
write(File, int, List<DescribedEndpoint>, String, boolean) - Method in class com.arc_e_tect.gradle.mirage.report.MirageApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.
write(File, int, List<DescribedEndpoint>, String, boolean, Map<String, ContractProgressRecord>) - 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 F G M N S T U W
All Classes and Interfaces|All Packages|Constant Field Values