Skip to content

API Reference

Complete API documentation is available in the Maven-generated Javadoc site. Run mvn javadoc:aggregate to generate it locally at target/site/apidocs/.

Package Overview

fhir-frog-library

Core library packages.

Package Description
org.fhirfrog.frog Shared enumerations (FhirVersion)
org.fhirfrog.frog.api Public API: FhirTestConfig, TestResult, annotations
org.fhirfrog.frog.executor Non-JUnit executors for CLI / build tools
org.fhirfrog.frog.junit JUnit Platform launcher wrappers
org.fhirfrog.frog.internal JUnit 5 extension wiring (internal)
org.fhirfrog.frog.internal.testscript Core TestScript engine (internal)

fhir-frog-ant

Ant build integration.

Package Description
org.fhirfrog.frog.ant FhirTestTask, FhirInitTask, FhirBootstrapTask
org.fhirfrog.frog.ant.ig IG dependency resolution and Docker config generation
org.fhirfrog.frog.ant.report Surefire XML report writer

fhir-frog-testplan

TestPlan expansion and JUnit integration.

Package Description
org.fhirfrog.frog.testplan TestPlan expansion, dependency graph, cycle detection
org.fhirfrog.frog.executor TestPlanExecutor for non-JUnit deployment
org.fhirfrog.frog.junit ProgrammaticTestExecutor bridge

Other Modules

Package Module Description
org.fhirfrog.frog.rendering fhir-frog-rendering TestReport rendering and storage
org.fhirfrog.frog.shorthand fhir-frog-shorthand TestScript Shorthand (TSH) parser
org.fhirfrog.frog.tph fhir-frog-testplan-shorthand TestPlan Shorthand (TPH) parser
org.fhirfrog.frog.cli fhir-frog-cli CLI entry point
org.fhirfrog.frog.maven fhir-frog-maven-plugin Maven Mojo

Architecture Diagrams

Key packages include PlantUML architecture diagrams rendered in their Javadoc. After running mvn javadoc:aggregate, navigate to:

  • org.fhirfrog.frog.api — Overall component architecture
  • org.fhirfrog.frog.internal.testscript — TestScript engine pipeline
  • org.fhirfrog.frog.testplan — TestPlan expansion structure
  • org.fhirfrog.frog.ant.ig — IG bootstrap orchestration
  • org.fhirfrog.frog.rendering — Rendering flow

Generating the Javadoc Site

# Generate aggregate Javadoc (all modules)
mvn javadoc:aggregate

# Open in browser
open target/site/apidocs/index.html

# Generate the full Maven site (Javadoc + test reports + plugin docs)
mvn site site:stage
open target/staging/index.html

Next Steps