How sw-fantastic/web-sdk-creator works
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