# jimsong9345/spring-graphql architecture

> Architecture diagram of the GitHub repository jimsong9345/spring-graphql, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jimsong9345/spring-graphql
- Repository: https://github.com/jimsong9345/spring-graphql

## Overview

##### Project type and purpose
- This is a multi‐module, open‐source library and documentation project (“Spring for GraphQL”).
- It provides GraphQL support on the Spring platform by building on GraphQL Java.
- It includes:
– Core library modules implementing server and client APIs, execution, data binding, observation, etc.
– A test module with reusable test utilities for GraphQL flows.
– A documentation site module (Antora‐based).
– A “platform” BOM module for dependency management.
– Build‐logic plugins under buildSrc.
– CI/CD workflows and publication steps.

##### File structure
Top-level elements:
- build.gradle / settings.gradle / gradle.properties – root build.
- buildSrc/ – Gradle plugins and architecture checks used by all modules.
- platform/ – Bill of Materials for version alignment across Spring GraphQL and dependencies.
- spring-graphql/ – Core library, subpackages by concern: server (webflux, webmvc, transports), client (HTTP, WebSocket, RSocket), data (repository bindings, federation), execution (GraphQlSource builders, exception resolvers), observation (Micrometer), support classes, resources (graphiql, native‐image configs).
- spring-graphql-test/ – Utilities for testing clients and servers, GraphQlTester implementations, transport mocks, AOT support.
- spring-graphql-docs/ – Antora playbook, AsciiDoc pages, sample Java code under src/main/java/org/springframework/graphql/docs. Produces published reference docs.
- .github/ – Actions that orchestrate build, publish, release, docs deployment, sync to Maven central, etc.

##### Additional insights from the README
- Emphasis on reference documentation (published and source).
- Samples in legacy branch will be moved out.
- GraphQL Java is the underlying execution engine.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Build Layer
    subgraph "Build Layer"
        direction TB
        RootGradle["Root Gradle Configuration"]:::build
        GradleWrapper["Gradle Wrapper"]:::build
        subgraph "buildSrc Plugins"
            direction TB
            ConventionsPlugin["ConventionsPlugin"]:::build
            ArchitecturePlugin["ArchitecturePlugin"]:::build
            ArchitectureCheck["ArchitectureCheck"]:::build
            ArchitectureRules["ArchitectureRules"]:::build
        end
        RootGradle -->|includes| GradleWrapper
        RootGradle -->|includes| ConventionsPlugin
        RootGradle -->|includes| ArchitecturePlugin
        RootGradle -->|includes| ArchitectureCheck
        RootGradle -->|includes| ArchitectureRules
    end

    %% Core Libraries
    subgraph "Core Libraries"
        direction TB
        PlatformBOM["platform (BOM)"]:::core
        SpringGraphql["spring-graphql"]:::core
        subgraph "spring-graphql Modules"
            direction TB
            ClientAPI["Client APIs"]:::core
            ServerAPI["Server APIs"]:::core
            DataBinding["Data Binding & Federation"]:::core
            Execution["Execution & GraphQlSource"]:::core
            Observation["Observation (Micrometer)"]:::core
            Support["Support & Resources"]:::core
        end
        PlatformBOM -->|dependency alignment| SpringGraphql
        SpringGraphql --> ClientAPI
        SpringGraphql --> ServerAPI
        SpringGraphql --> DataBinding
        SpringGraphql --> Execution
        SpringGraphql --> Observation
        SpringGraphql --> Support
    end

    %% Test & Docs
    subgraph "Test & Docs"
        direction TB
        SpringGraphqlTest["spring-graphql-test"]:::testdocs
        SpringGraphqlDocs["spring-graphql-docs"]:::testdocs
        SpringGraphqlTest -->|depends on| SpringGraphql
        SpringGraphqlDocs -->|uses samples from| SpringGraphql
    end

    %% CI/CD
    subgraph "CI/CD Pipelines"
        direction TB
        GitHubActions["GitHub Actions Workflows"]:::ci
        GitHubActions -->|triggers build/test/docs| RootGradle
        GitHubActions -->|deploy| SpringGraphqlDocs
        GitHubActions -->|publish| SpringGraphql
    end

    %% External Dependencies
    subgraph "External Dependencies"
        direction TB
        SpringFramework["Spring Framework"]:::external
        GraphQLJava["GraphQL Java"]:::external
        Micrometer["Micrometer"]:::external
        Antora["Antora/AsciiDoc"]:::external
        MavenCentral["Maven Central"]:::external
    end
    SpringGraphql -->|uses| SpringFramework
    SpringGraphql -->|builds on| GraphQLJava
    Observation -->|reports via| Micrometer
    SpringGraphqlDocs -->|generates via| Antora
    SpringGraphql -->|publishes to| MavenCentral

    %% Click Events
    click RootGradle "https://github.com/jimsong9345/spring-graphql/blob/main/./build.gradle"
    click ConventionsPlugin "https://github.com/jimsong9345/spring-graphql/blob/main/buildSrc/src/main/java/org/springframework/graphql/build/ConventionsPlugin.java"
    click ArchitecturePlugin "https://github.com/jimsong9345/spring-graphql/blob/main/buildSrc/src/main/java/org/springframework/graphql/build/architecture/ArchitecturePlugin.java"
    click ArchitectureCheck "https://github.com/jimsong9345/spring-graphql/blob/main/buildSrc/src/main/java/org/springframework/graphql/build/architecture/ArchitectureCheck.java"
    click ArchitectureRules "https://github.com/jimsong9345/spring-graphql/blob/main/buildSrc/src/main/java/org/springframework/graphql/build/architecture/ArchitectureRules.java"
    click PlatformBOM "https://github.com/jimsong9345/spring-graphql/blob/main/./platform/build.gradle"
    click SpringGraphql "https://github.com/jimsong9345/spring-graphql/blob/main/spring-graphql/build.gradle"
    click SpringGraphqlTest "https://github.com/jimsong9345/spring-graphql/blob/main/spring-graphql-test/build.gradle"
    click SpringGraphqlDocs "https://github.com/jimsong9345/spring-graphql/blob/main/spring-graphql-docs/build.gradle"
    click GitHubActions "https://github.com/jimsong9345/spring-graphql/blob/main/.github/workflows/ci.yml"

    %% Styles
    classDef build fill:#DDDDDD,stroke:#888888;
    classDef core fill:#ADD8E6,stroke:#1E90FF;
    classDef testdocs fill:#90EE90,stroke:#008000;
    classDef ci fill:#F0E68C,stroke:#DAA520;
    classDef external fill:#FFA500,stroke:#FF8C00;
```
