# sw-fantastic/web-sdk-creator architecture

> Architecture diagram of the GitHub repository sw-fantastic/web-sdk-creator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sw-fantastic/web-sdk-creator
- Repository: https://github.com/sw-fantastic/web-sdk-creator

## Overview

##### Project Type and Purpose
- This is an open-source desktop tool (“Web SDK Builder”) written in Java with a JavaFX GUI.
- Its purpose is to read Web API definitions (OpenAPI or endpoint lists), let the user configure endpoints, then generate a Java SDK source code and compile it into a JAR + POM.

##### High-Level Components
a. Frontend (UI)
- JavaFX Views & Controllers under `src/main/java/org/swdc/websdk/views` and FXML files under `src/main/resources/views`
- Skin & styling assets in `assets/skin`
- Config UI (SDKConfigView), Endpoint list view, modals for adding/importing endpoints, splash screen, etc.
b. Core Engine
- `org.swdc.websdk.core`: Data models for HttpEndpoint, HttpMethod, HttpHeader, HttpBodyEntry, etc.
- Generator subsystem under `core/generator`:
– Parsers: `OpenAPIParser`
– Descriptor builders: DataDescriptor, ClientDescriptor, EndPointSetDescriptor
– Generator factories & strategies: Java8/Java11 generators, Freemarker templates (`src/main/resources/template/java`)
- Compilation & Packaging: JavaCompiler API usage in `JavaSDKGenerator` & `JavaSDKPackager`
c. Persistence & I/O
- Reads/writes files: project config (`assets/config.json`), generated source, compiled JAR, POM.
- Uses `FileUtil` for file operations.
d. External Dependencies
- HTTP libraries (Apache HttpClient), JSON (Jackson), Freemarker templates, JavaFX runtime.
- Managed via embedded `.jar` in `assets/libraries` and `pom.xml` for build.

##### Interactions & Data Flow
1. User launches `SDKApplication` → `SplashView` → `SDKMainView`.
2. User imports an OpenAPI spec or manually adds endpoints via modals.
3. Controllers (`OpenAPIImportController`, `AddEndpointModal`, etc.) collect endpoint metadata and build `SDKProject` model.
4. Upon “Generate” action, `SDKGenerator` invokes:
a. `OpenAPIParser` (if needed) → creates descriptor contexts.
b. `GeneratorFactory` → selects Java generator → processes descriptors through Freemarker templates → writes .java files.
c. `JavaCompiler` API compiles them into `.class`.
d. `JavaSDKPackager` assembles compiled classes + resources + generated `pom.xml` → output JAR.
5. Tool shows status events via event bus (`views/events/*`).

##### Architectural Patterns & Principles
- MVC (Views ↔ Controllers ↔ Model in `core`)
- Strategy/Factory for generator selection (`GeneratorFactory`, `JavaSourceGeneratorFactory`)
- Event-driven updates in UI (`views/events`)
- Template-driven code generation (Freemarker)

##### Essential Elements
- Clear labels (UI, Core, I/O, Ext Libs)
- Annotation of key technologies: JavaFX, Jackson, Freemarker, JavaCompiler API, Apache HttpClient

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        Launcher["Launcher"]:::ui
        SDKApp["SDKApplication"]:::ui
        SplashView["SplashView"]:::ui
        SDKMainView["IDEMainView.fxml"]:::ui
        SDKMainCtrl["SDKMainController"]:::ui
        SDKConfigCtrl["SDKConfigController"]:::ui
        OpenAPIImportCtrl["OpenAPIImportController"]:::ui
        AddEndpointModal["AddEndpointModal"]:::ui
        EditEndpointSetModal["EditEndpointSetModal"]:::ui
        EndpointListCtrl["EndpointListController"]:::ui
        WebEndpointCtrl["WebEndpointController"]:::ui
        SDKConfigView["SDKConfigView.fxml"]:::ui
        WebEndpointView["WebEndpointView.fxml"]:::ui
        EndpointListView["EndpointList.fxml"]:::ui
        AddEndpointView["AddEndpointView.fxml"]:::ui
        AddEndpointSetView["AddEndpointSetView.fxml"]:::ui
        ImportOpenAPIView["ImportOpenAPIView.fxml"]:::ui
    end

    %% Core Layer
    subgraph "Core Layer"
        direction TB
        HttpModels["Data Models\n(HttpEndpoint, HttpMethod,\nHttpHeader, HttpBodyEntry,\nHttpPathVar, HttpQueryString,\nSDKProject, HttpEndpoints)"]:::core
        OpenAPIParser["OpenAPIParser"]:::core
        GeneratorFactory["GeneratorFactory"]:::core
        SDKGenerator["SDKGenerator"]:::core
        JavaGenFactory["JavaSourceGeneratorFactory\n(Java8/Java11)"]:::core
        JavaSDKGenerator["JavaSDKGenerator"]:::core
        JavaSDKPackager["JavaSDKPackager"]:::core
        FileUtil["FileUtil"]:::core
    end

    %% I/O Layer
    subgraph "I/O & Persistence"
        direction TB
        ConfigJSON["assets/config.json"]:::io
        Templates["Freemarker Templates\n(src/main/resources/template/java)"]:::io
        OutputArtifacts["Generated .java, .class,\nPOM, JAR"]:::io
    end

    %% External Dependencies
    subgraph "External Libraries"
        direction TB
        ApacheHTTP["Apache HttpClient"]:::external
        Jackson["Jackson JSON"]:::external
        Freemarker["Freemarker"]:::external
        JavaFX["JavaFX Runtime"]:::external
        JavaCompilerAPI["JavaCompiler API"]:::external
    end

    %% Flows
    Launcher --> SDKApp
    SDKApp --> SplashView
    SplashView --> SDKMainView
    SDKMainView --> SDKMainCtrl
    SDKMainCtrl --> SDKConfigCtrl
    SDKMainCtrl --> OpenAPIImportCtrl
    SDKMainCtrl --> AddEndpointModal
    SDKMainCtrl --> EditEndpointSetModal
    SDKMainCtrl --> EndpointListCtrl
    SDKMainCtrl --> WebEndpointCtrl

    SDKMainCtrl -->|"generate"| SDKGenerator
    OpenAPIImportCtrl --> OpenAPIParser
    SDKGenerator --> OpenAPIParser
    SDKGenerator --> GeneratorFactory
    GeneratorFactory --> JavaGenFactory
    JavaGenFactory --> JavaSDKGenerator
    JavaSDKGenerator --> JavaSDKPackager
    JavaSDKGenerator --> FileUtil
    JavaSDKPackager --> FileUtil

    FileUtil --> ConfigJSON
    FileUtil --> Templates
    JavaSDKPackager --> OutputArtifacts

    OpenAPIParser --> Jackson
    JavaSDKGenerator --> JavaCompilerAPI
    JavaSDKGenerator --> Freemarker
    SDKApp --> JavaFX
    SDKMainView --> JavaFX
    SDKMainCtrl --> JavaFX
    SDKGenerator --> ApacheHTTP

    %% Click Events
    click Launcher "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/Launcher.java"
    click SDKApp "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/SDKApplication.java"
    click SplashView "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/SplashView.java"
    click SDKMainView "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/resources/views/main/IDEMainView.fxml"
    click SDKMainCtrl "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/views/SDKMainController.java"
    click SDKConfigCtrl "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/views/SDKConfigController.java"
    click OpenAPIImportCtrl "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/views/OpenAPIImportController.java"
    click AddEndpointModal "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/views/AddEndpointModal.java"
    click EditEndpointSetModal "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/views/EditEndpointSetModal.java"
    click EndpointListCtrl "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/views/EndpointListController.java"
    click WebEndpointCtrl "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/views/WebEndpointController.java"
    click SDKConfigView "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/resources/views/main/SDKConfigView.fxml"
    click WebEndpointView "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/resources/views/main/WebEndpointView.fxml"
    click EndpointListView "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/resources/views/main/EndpointList.fxml"
    click AddEndpointView "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/resources/views/modal/AddEndpointView.fxml"
    click AddEndpointSetView "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/resources/views/modal/AddEndpointSetView.fxml"
    click ImportOpenAPIView "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/resources/views/modal/ImportOpenAPIView.fxml"
    click HttpModels "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/core/HttpEndpoint.java"
    click OpenAPIParser "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/core/generator/OpenAPIParser.java"
    click GeneratorFactory "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/core/generator/GeneratorFactory.java"
    click SDKGenerator "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/core/generator/SDKGenerator.java"
    click JavaSDKGenerator "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/core/generator/java/JavaSDKGenerator.java"
    click JavaSDKPackager "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/core/generator/java/JavaSDKPackager.java"
    click FileUtil "https://github.com/sw-fantastic/web-sdk-creator/blob/master/src/main/java/org/swdc/websdk/core/generator/FileUtil.java"
    click Templates "https://github.com/sw-fantastic/web-sdk-creator/tree/master/src/main/resources/template/java"
    click ConfigJSON "https://github.com/sw-fantastic/web-sdk-creator/blob/master/assets/config.json"
    click ApacheHTTP "https://github.com/sw-fantastic/web-sdk-creator/blob/master/assets/libraries/httpclient-4.5.14.jar"
    click Jackson "https://github.com/sw-fantastic/web-sdk-creator/blob/master/assets/libraries/jackson-core-*.jar"
    click Freemarker "https://github.com/sw-fantastic/web-sdk-creator/blob/master/assets/libraries/freemarker-*.jar"
    click JavaCompilerAPI "https://github.com/sw-fantastic/web-sdk-creator/tree/master/built-in"
    click JavaFX "https://github.com/sw-fantastic/web-sdk-creator/blob/master/pom.xml"

    %% Styles
    classDef ui fill:#D6EAF8,stroke:#21618C,stroke-width:1px
    classDef core fill:#D4EFDF,stroke:#196F3D,stroke-width:1px
    classDef io fill:#FAD7A0,stroke:#B9770E,stroke-width:1px
    classDef external fill:#D5D8DC,stroke:#566573,stroke-width:1px
```
