# anyanit/api-test-framework-sparta-academy-api- architecture

> Architecture diagram of the GitHub repository anyanit/api-test-framework-sparta-academy-api-, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-05-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/anyanit/api-test-framework-sparta-academy-api-
- Repository: https://github.com/anyanit/api-test-framework-sparta-academy-api-

## Overview

1. This repository is a test automation framework, not an application service. Its only runtime target is the external Sparta Academy REST API, which acts as the system under test.

2. The architecture is centered on a BDD testing flow:
   - Gherkin scenarios in `src/test/resources/features`
   - Java step definitions in `src/test/java/com/sparta/steps`
   - A shared API utility layer in `src/test/java/com/sparta/utils/ApiBuilder.java`
   - HTTP execution and assertions through RestAssured

3. `CucumberRunnerTest` is the main test entry point. It ties JUnit 5 to the Cucumber feature suite and is the class the README identifies as the way to run the framework end-to-end.

4. The step-definition layer is split by endpoint or behavior, which is the main functional boundary in the repo:
   - login: `/Auth/login`
   - courses: `/api/Courses`
   - spartans: `/api/Spartans`
   - CRUD variants for create, search, update, and delete
   This keeps scenario steps thin and pushes reusable request/response logic into helpers.

5. `ApiBuilder` is the central service-object-style abstraction. It likely owns request setup, endpoint selection, headers/authentication, and response capture. In architectural terms, it is the seam between readable BDD tests and low-level HTTP calls.

6. The POJO package (`Course`, `LoginRequest`, `Spartan`, `Stream`) provides typed models for request payloads and response deserialization. This is the main data model boundary in the test stack, separating raw JSON from Java assertions.

7. Test data is externalized in `src/test/resources/external`:
   - `NewSpartan.json`
   - `UpdatedSpartan.json`
   - `MissingFirstNameSpartan.json`
   These files support happy-path and negative-path payload variation without embedding JSON inside step code.

8. `config.properties` is the environment/config boundary. It is used to parameterize the test run with values such as base URLs, credentials, or other environment-specific settings instead of hardcoding them in scenarios.

9. The validation strategy spans both positive and negative coverage. The framework checks status codes, response bodies, and schema-like expectations for successful requests, while also covering bad input, missing fields, invalid credentials, and unauthorized access.

10. The repo is built with Maven and organized as a test-only project under `src/test`, with no production source tree. CI is present via `.github/workflows/maven-publish.yml`, so the framework is intended to be executed and published through automated build infrastructure rather than deployed as an app.

11. The main technology boundaries are:
   - Cucumber/Gherkin for scenario definition
   - JUnit 5 for execution
   - RestAssured for HTTP interaction
   - Jackson / JSON Simple for JSON handling
   - Maven for dependency/build management
   This stack shapes the architecture around readable test specs, reusable request logic, and API-level assertions.

12. For an architecture diagram, the key flow is:
   feature files → step definitions → ApiBuilder / POJOs / test resources → RestAssured → Sparta Academy API → assertions back in the test runner.

Main entry points: [`src/test/java/com/sparta/utils/ApiBuilder.java`](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/utils/ApiBuilder.java) (ApiBuilder), [`src/test/resources/features`](https://github.com/anyanit/api-test-framework-sparta-academy-api-/tree/master/src/test/resources/features) (Feature Specs), [`src/test/java/com/sparta/runner/CucumberRunnerTest.java`](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/runner/CucumberRunnerTest.java) (Cucumber Runner), [`src/test/java/com/sparta/steps/UserLoginSteps.java`](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/UserLoginSteps.java) (Login Steps)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_grp_test_entry["Execution"]
  node_node_runner["Cucumber Runner<br/>JUnit 5 runner"]
  node_node_build["Maven Build<br/>build tool<br/>[pom.xml]"]
  node_node_ci["CI Workflow<br/>GitHub Actions<br/>[maven-publish.yml]"]
end

subgraph group_grp_bdd["BDD Flow"]
  node_node_features["Feature Specs<br/>Gherkin scenarios"]
  node_node_login_steps["Login Steps<br/>step defs"]
  node_node_course_steps["Course Steps<br/>step defs"]
  node_node_course_id_steps["Course ID Steps<br/>step defs"]
  node_node_spartan_steps["Spartan Steps<br/>step defs"]
  node_node_spartan_id_steps["Spartan ID Steps<br/>step defs"]
  node_node_create_steps["Create Steps<br/>step defs"]
  node_node_update_steps["Update Steps<br/>step defs"]
  node_node_delete_steps["Delete Steps<br/>step defs"]
end

subgraph group_grp_api_core["HTTP Core"]
  node_node_api_builder["ApiBuilder<br/>request helper<br/>[ApiBuilder.java]"]
  node_node_restassured["RestAssured<br/>HTTP client"]
end

subgraph group_grp_data["Test Data"]
  node_node_pojos["Typed Models<br/>POJOs"]
  node_node_external_json["JSON Fixtures<br/>test payloads"]
end

subgraph group_grp_runtime["External Runtime"]
  node_node_config["Config Props<br/>environment config<br/>[config.properties]"]
  node_node_api[("Sparta API<br/>system under test")]
end

node_node_ci -->|"runs"| node_node_build
node_node_build -->|"executes"| node_node_runner
node_node_runner -->|"loads"| node_node_features
node_node_features -->|"binds"| node_node_login_steps
node_node_features -->|"binds"| node_node_course_steps
node_node_features -->|"binds"| node_node_course_id_steps
node_node_features -->|"binds"| node_node_spartan_steps
node_node_features -->|"binds"| node_node_spartan_id_steps
node_node_features -->|"binds"| node_node_create_steps
node_node_features -->|"binds"| node_node_update_steps
node_node_features -->|"binds"| node_node_delete_steps
node_node_login_steps -->|"uses"| node_node_api_builder
node_node_course_steps -->|"uses"| node_node_api_builder
node_node_course_id_steps -->|"uses"| node_node_api_builder
node_node_spartan_steps -->|"uses"| node_node_api_builder
node_node_spartan_id_steps -->|"uses"| node_node_api_builder
node_node_create_steps -->|"uses"| node_node_api_builder
node_node_update_steps -->|"uses"| node_node_api_builder
node_node_delete_steps -->|"uses"| node_node_api_builder
node_node_api_builder -->|"drives"| node_node_restassured
node_node_api_builder -->|"reads"| node_node_config
node_node_api_builder -->|"serializes"| node_node_pojos
node_node_create_steps -->|"loads"| node_node_external_json
node_node_update_steps -->|"loads"| node_node_external_json
node_node_api_builder -->|"calls"| node_node_api
node_node_login_steps -->|"uses"| node_node_pojos
node_node_runner -->|"verifies"| node_node_api

click node_node_runner "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/runner/CucumberRunnerTest.java"
click node_node_build "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/pom.xml"
click node_node_ci "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/.github/workflows/maven-publish.yml"
click node_node_features "https://github.com/anyanit/api-test-framework-sparta-academy-api-/tree/master/src/test/resources/features"
click node_node_login_steps "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/UserLoginSteps.java"
click node_node_course_steps "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/SearchAllCoursesSteps.java"
click node_node_course_id_steps "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/SearchCourseWithIdSteps.java"
click node_node_spartan_steps "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/SearchAllSpartansSteps.java"
click node_node_spartan_id_steps "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/SearchSpartanWithIdSteps.java"
click node_node_create_steps "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/CreateNewSpartanSteps.java"
click node_node_update_steps "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/UpdateSpartanSteps.java"
click node_node_delete_steps "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/DeleteSpartanSteps.java"
click node_node_api_builder "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/utils/ApiBuilder.java"
click node_node_pojos "https://github.com/anyanit/api-test-framework-sparta-academy-api-/tree/master/src/test/java/com/sparta/pojos"
click node_node_external_json "https://github.com/anyanit/api-test-framework-sparta-academy-api-/tree/master/src/test/resources/external"
click node_node_config "https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/resources/config.properties"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_node_runner,node_node_build,node_node_ci toneBlue
class node_node_features,node_node_login_steps,node_node_course_steps,node_node_course_id_steps,node_node_spartan_steps,node_node_spartan_id_steps,node_node_create_steps,node_node_update_steps,node_node_delete_steps toneAmber
class node_node_api_builder,node_node_restassured toneMint
class node_node_pojos,node_node_external_json toneRose
class node_node_config,node_node_api toneIndigo
```

## Components

### Execution

Test runner and build entry points.

- [Cucumber Runner](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/runner/CucumberRunnerTest.java): JUnit 5 runner · Main test entry point that executes the Cucumber suite end to end. · `src/test/java/com/sparta/runner/CucumberRunnerTest.java`
- [Maven Build](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/pom.xml): build tool · Build and dependency management for the test-only project. · `pom.xml`
- [CI Workflow](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/.github/workflows/maven-publish.yml): GitHub Actions · Automated workflow for running and publishing the test framework. · `.github/workflows/maven-publish.yml`

### BDD Flow

Cucumber features and step definitions.

- [Feature Specs](https://github.com/anyanit/api-test-framework-sparta-academy-api-/tree/master/src/test/resources/features): Gherkin scenarios · Readable BDD scenarios that define API behavior to verify. · `src/test/resources/features`
- [Login Steps](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/UserLoginSteps.java): step defs · Step definitions for authentication and login behavior. · `src/test/java/com/sparta/steps/UserLoginSteps.java`
- [Course Steps](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/SearchAllCoursesSteps.java): step defs · Step definitions for course search flows. · `src/test/java/com/sparta/steps/SearchAllCoursesSteps.java`
- [Course ID Steps](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/SearchCourseWithIdSteps.java): step defs · Step definitions for single-course lookup by id. · `src/test/java/com/sparta/steps/SearchCourseWithIdSteps.java`
- [Spartan Steps](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/SearchAllSpartansSteps.java): step defs · Step definitions for listing and finding spartans. · `src/test/java/com/sparta/steps/SearchAllSpartansSteps.java`
- [Spartan ID Steps](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/SearchSpartanWithIdSteps.java): step defs · Step definitions for single-spartan lookup by id. · `src/test/java/com/sparta/steps/SearchSpartanWithIdSteps.java`
- [Create Steps](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/CreateNewSpartanSteps.java): step defs · Step definitions for creating spartans. · `src/test/java/com/sparta/steps/CreateNewSpartanSteps.java`
- [Update Steps](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/UpdateSpartanSteps.java): step defs · Step definitions for updating spartans. · `src/test/java/com/sparta/steps/UpdateSpartanSteps.java`
- [Delete Steps](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/steps/DeleteSpartanSteps.java): step defs · Step definitions for deleting spartans. · `src/test/java/com/sparta/steps/DeleteSpartanSteps.java`

### HTTP Core

Reusable API request and assertion layer.

- [ApiBuilder](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/java/com/sparta/utils/ApiBuilder.java): request helper · Shared abstraction for request setup, endpoint selection, auth, execution, and response capture. · `src/test/java/com/sparta/utils/ApiBuilder.java`
- **RestAssured**: HTTP client · Library used to issue API requests and inspect responses.

### Test Data

Typed payload models and external JSON fixtures.

- [Typed Models](https://github.com/anyanit/api-test-framework-sparta-academy-api-/tree/master/src/test/java/com/sparta/pojos): POJOs · Java request/response models used for serialization and assertions. · `src/test/java/com/sparta/pojos`
- [JSON Fixtures](https://github.com/anyanit/api-test-framework-sparta-academy-api-/tree/master/src/test/resources/external): test payloads · Externalized request bodies for create and update scenarios. · `src/test/resources/external`

### External Runtime

System under test and environment configuration.

- [Config Props](https://github.com/anyanit/api-test-framework-sparta-academy-api-/blob/master/src/test/resources/config.properties): environment config · External configuration for base URLs, credentials, and run-time settings. · `src/test/resources/config.properties`
- **Sparta API**: system under test · External REST API exercised by the framework.

## Connections

- CI Workflow → Maven Build: runs · CI executes the Maven build and test lifecycle.
- Maven Build → Cucumber Runner: executes · Maven/JUnit launch the Cucumber runner.
- Cucumber Runner → Feature Specs: loads · Runner discovers and executes feature specifications.
- Feature Specs → Login Steps: binds · Scenarios map to authentication step definitions.
- Feature Specs → Course Steps: binds · Scenarios map to course listing steps.
- Feature Specs → Course ID Steps: binds · Scenarios map to course-by-id steps.
- Feature Specs → Spartan Steps: binds · Scenarios map to spartan listing steps.
- Feature Specs → Spartan ID Steps: binds · Scenarios map to spartan-by-id steps.
- Feature Specs → Create Steps: binds · Scenarios map to create-spartan steps.
- Feature Specs → Update Steps: binds · Scenarios map to update-spartan steps.
- Feature Specs → Delete Steps: binds · Scenarios map to delete-spartan steps.
- Login Steps → ApiBuilder: uses · Steps delegate HTTP work to the shared builder.
- Course Steps → ApiBuilder: uses · Steps delegate HTTP work to the shared builder.
- Course ID Steps → ApiBuilder: uses · Steps delegate HTTP work to the shared builder.
- Spartan Steps → ApiBuilder: uses · Steps delegate HTTP work to the shared builder.
- Spartan ID Steps → ApiBuilder: uses · Steps delegate HTTP work to the shared builder.
- Create Steps → ApiBuilder: uses · Steps delegate HTTP work to the shared builder.
- Update Steps → ApiBuilder: uses · Steps delegate HTTP work to the shared builder.
- Delete Steps → ApiBuilder: uses · Steps delegate HTTP work to the shared builder.
- ApiBuilder → RestAssured: drives · Builder wraps the underlying HTTP execution library.
- ApiBuilder → Config Props: reads · Builder and tests consume environment settings from properties.
- ApiBuilder → Typed Models: serializes · Builder works with typed payloads and response models.
- Create Steps → JSON Fixtures: loads · Create scenarios source payload variants from external JSON.
- Update Steps → JSON Fixtures: loads · Update scenarios source payload variants from external JSON.
- ApiBuilder → Sparta API: calls · HTTP requests are executed against the external Sparta Academy API.
- Login Steps → Typed Models: uses · Login payloads are represented with typed request models.
- Cucumber Runner → Sparta API: verifies · The end-to-end test run asserts behavior against the system under test.
