How discord4j/discord-json works
Project type and purpose
• This is an open-source, multi-module Java library (“discord-json”) that defines immutable Jackson-annotated domain objects representing Discord’s REST and Gateway JSON schemas.
• It’s published to Maven Central, built with Gradle under JDK 11, and provides two supplementary modules (“api” and “encoding”) in addition to the core JSON model definitions.
File structure
• Top level: build scripts (build.gradle, settings.gradle), root Gradle wrapper, CI configuration (jitpack.yml, .github/workflows/gradle.yml), license, README.
• Modules:
• core (implicit root module under src/main/java/discord4j/discordjson/json and json/gateway) – defines all JSON data classes.
• api – an independent Gradle subproject exposing Jackson modules and interfaces for downstream consumers (discord4j.discordjson.possible packages).
• encoding – another subproject providing Jackson encoders/decoders (discordjson.encoding packages) for ID and “possible” types.
• Tests for each module under src/test/java and resources under src/test/resources.
• Configuration: logback.xml, Gradle properties, .editorconfig, .gitignore.
README for additional insights
• Describes the library’s goal: “Discord entity domain now available as immutable Jackson objects.”
• Mentions dependencies: Immutables, Jackson Databind, JDK 11.
a. Main components:
• Gradle Build System (root)
• Core JSON Model Module (“core”)
• API Module (“api”)
• Encoding Module (“encoding”)
• External Dependencies: Jackson Databind, Immutables, JDK libraries
• Test Harness (unit tests + test resources)
• Consumers (Discord4J library, third-party applications)
b. Relationships and interactions:
• Build System orchestrates compilation of all modules and runs tests.
• core defines immutable data classes; api and encoding declare dependencies on core.
• api provides Jackson modules to plug domain types into Jackson’s ObjectMapper.
• encoding supplies custom serializers/deserializers plugged into Jackson.
• Consumers import the published JARs (core, api, encoding) via Maven Central.
c. Architectural patterns and design principles:
• Modularization – clear separation of model, API, encoding logic.
• Layered abstraction – core data → API integration layer → encoding/serialization layer.
• Convention-based packaging for JSON schema and gateway events.
d. Key technologies and libraries:
• Build: Gradle, JDK 11, Gradle Wrapper
• JSON mapping: Jackson Databind, custom Jackson Modules
• Immutables (for generating immutable value objects)
• Testing: JUnit, JSON fixtures under test/resources