Merge pull request #57 from Kucoin/dev

Add Java Implementation

Author: ISAAC-XXYYZZ

.github/workflows/upload-java-sdk-package.yml

@@ -0,0 +1,36 @@
+name: Publish Java Package to Maven Central
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+          cache: 'maven'
+          server-id: ossrh
+          server-username: OSSRH_USERNAME
+          server-password: OSSRH_PASSWORD
+          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
+          gpg-passphrase: MAVEN_GPG_PASSPHRASE
+
+      - name: Publish to Apache Maven Central
+        run: mvn deploy -DskipTest
+        working-directory: sdk/java
+        env:
+          OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+          OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

CHANGELOG.md

@@ -4,6 +4,9 @@ API documentation [Changelog](https://www.kucoin.com/docs-new/change-log)
 
 Current synchronized API documentation version [20250529](https://www.kucoin.com/docs-new/change-log#20250529)
 
+## 2025-07-30(Java 0.1.0-alpha)
+- Release Java implementation
+
 ## 2025-06-11(PHP 0.1.3-alpha)
 - Add compatibility for PHP versions from 7.4 to 8.x 
 

Dockerfile

@@ -1,18 +1,10 @@
 # build plugin
-FROM amazoncorretto:11-alpine AS generator-builder
+FROM maven:3.9.10-amazoncorretto-17-debian-bookworm AS generator-builder
 
 ENV MAVEN_VERSION=3.8.8
 ENV MAVEN_HOME=/usr/share/maven
 ENV PATH=${MAVEN_HOME}/bin:${PATH}
 
-RUN apk add --no-cache curl tar bash \
-    && echo ${MAVEN_HOME} \
-    && curl -fsSL https://downloads.apache.org/maven/maven-3/${MAVEN_VERSION}/binaries/apache-maven-${MAVEN_VERSION}-bin.tar.gz | tar -xzC /usr/share \
-    && mv /usr/share/apache-maven-${MAVEN_VERSION} ${MAVEN_HOME} \
-    && ln -s ${MAVEN_HOME}/bin/mvn /usr/bin/mvn \
-    && apk del curl tar
-
-
 WORKDIR /build
 
 COPY ./generator/plugin /build
@@ -22,7 +14,7 @@ RUN --mount=type=cache,target=/root/.m2,sharing=locked mvn -U clean package -Dsk
 # build tools 
 FROM openapitools/openapi-generator-cli:v7.7.0
 
-RUN apt-get update && apt-get install python3 python3-pip python3.8-venv nodejs jq npm -y
+RUN apt-get update && apt-get install python3 python3-pip python3.8-venv nodejs jq npm clang-format -y
 RUN pip install yapf
 ENV GOLANG_VERSION=1.22.2
 RUN curl -OL https://golang.org/dl/go${GOLANG_VERSION}.linux-amd64.tar.gz && \
@@ -49,6 +41,7 @@ ENV GO_POST_PROCESS_FILE="/usr/local/go/bin/gofmt -w"
 ENV PYTHON_POST_PROCESS_FILE="/usr/local/bin/yapf -i"
 ENV TS_POST_PROCESS_FILE="/usr/bin/prettier --write --semi --single-quote --tab-width 4 --trailing-comma all --bracket-spacing --arrow-parens always --end-of-line lf --print-width 100"
 ENV PHP_POST_PROCESS_FILE="php-prettier --write"
+ENV JAVA_POST_PROCESS_FILE="/usr/bin/clang-format -i"
 
 ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
 

Makefile

@@ -68,12 +68,16 @@ define generate-code
 	@echo "$(GREEN)lang: ${lang}, copy changelog...$(NC)"
 	docker run --rm -v "${PWD}:/local" $(IMAGE_NAME):$(IMAGE_TAG) cp /local/CHANGELOG.md /local/sdk/$(lang)
 
-	@make -f generate.mk generate lang=$(1) subdir=$(2) USER_VERSION=$(3)
+	@$(MAKE) -f generate.mk generate lang=$(1) subdir=$(2) USER_VERSION=$(3)
 
 	@echo "$(GREEN)lang: $(lang), clean...$(NC)"
 	docker run --rm -v "${PWD}:/local" $(IMAGE_NAME):$(IMAGE_TAG) rm -rf $(outdir)/.openapi-generator
 	docker run --rm -v "${PWD}:/local" $(IMAGE_NAME):$(IMAGE_TAG) rm -rf $(outdir)/.openapi-generator-ignore
 
+	@echo "$(GREEN)lang: $(lang), format project...$(NC)"
+	@sleep 5
+	@$(MAKE) -C sdk/$(lang) format
+
 	@echo "$(GREEN)lang: $(lang), done!$(NC)"
 endef
 
@@ -88,7 +92,8 @@ generate: setup-logs
 	$(call generate-code,golang,/pkg/generate)
 	$(call generate-code,python,/kucoin_universal_sdk/generate)
 	$(call generate-code,node,/src/generate)
-	$(call generate-code,php,/src/Generate,0.1.2-alpha)
+	$(call generate-code,php,/src/Generate,0.1.3-alpha)
+	$(call generate-code,java,/src/main/java/com/kucoin/universal/sdk/generate,0.1.0-alpha)
 
 .PHONY: gen-postman
 gen-postman: preprocessor

README.md

@@ -58,6 +58,16 @@ npm install kucoin-universal-sdk
 composer require kucoin/kucoin-universal-sdk=0.1.3-alpha
 ```
 
+### Java Installation(0.1.0-alpha)
+**Note**: This SDK is currently in the Alpha phase. We are actively iterating and improving its features, stability, and documentation. Feedback and contributions are highly encouraged to help us refine the SDK.
+```bash
+<dependency>
+    <groupId>com.kucoin</groupId>
+    <artifactId>kucoin-universal-sdk</artifactId>
+    <version>0.1.0-alpha</version>
+</dependency>
+```
+
 ### Postman Installation  
 Visit the [KuCoin API Collection on Postman](https://www.postman.com/kucoin-api/kucoin-api/overview)
 
@@ -137,6 +147,7 @@ For other languages, refer to the [Examples](#-examples) section.
 - **[Go Documentation](sdk/golang/README.md)**
 - **[Node.js Documentation](sdk/node/README.md)**
 - **[PHP Documentation](sdk/php/README.md)**
+- **[Java Documentation](sdk/java/README.md)**
 - **[Postman Documentation](sdk/postman/README.md)**
 
 ## 📂 Examples
@@ -147,7 +158,8 @@ Find usage examples for your desired language by selecting the corresponding lin
 | Python   | [sdk/python/examples/](sdk/python/example/)|
 | Go       | [sdk/go/examples/](sdk/golang/example/)    |
 | Node.js  | [sdk/node/examples/](sdk/node/example/)    |
-| PHP  | [sdk/php/examples/](sdk/php/example/)    |
+| PHP      | [sdk/php/examples/](sdk/php/example/)      |
+| Java     | [sdk/java/examples/](sdk/java/example/)    |
 
 ## 📋 Changelog
 
@@ -236,12 +248,7 @@ Before you begin, ensure the following dependencies are installed:
 
 5. **Run Tests**  
    Run automatically generated tests for all SDKs.
-   Command: `make test`
-
-6. **Run All Steps**  
-   Execute the entire pipeline: build tools, preprocess specifications, validate, and generate code.  
-   Command: `make all`
-
+   Command: `make auto-test`
 
 ## 🤝 Contribution Guidelines
 

generator/plugin/pom.xml

@@ -17,6 +17,7 @@
         <maven.compiler.plugin.version>3.6.1</maven.compiler.plugin.version>
         <ascii-table.version>1.8.0</ascii-table.version>
         <csv.version>5.7.1</csv.version>
+        <commons-lang3.version>3.17.0</commons-lang3.version>
     </properties>
 
     <dependencies>
@@ -43,6 +44,12 @@
             <version>${csv.version}</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>${commons-lang3.version}</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>