English | 中文

Introduction

apideploy-jakarta-client is a java project API document automatic generation toolkit and apideploy.com website deployment SDK. It supports Swagger3 (OAS 3.0), Javadoc specifications, and Java development frameworks such as Spring WebMVC, Spring WebFlux and Apache Dubbo's documentation comments.

Note: This client is suitable for springboot 3.0+ projects using Java 17 or above. The swagger part is implemented based on springdoc. For the implementation of java1.8 or below, please use apideploy-java-client.

Guides

1.Add maven dependency to pom.xml.

You have to choose the appropriate dependencies according to the framework of your project. The following is the correspondence between maven dependencies and frameworks.

/	Swagger3(OAS 3.0)	Javadoc
Spring WebMVC	<dependency> <groupId>com.kalman03</groupId> <artifactId>apideploy-jakarta-swagger3-webmvc</artifactId> </dependency>	<dependency> <groupId>com.kalman03</groupId> <artifactId>apideploy-jakarta-javadoc-springweb</artifactId> </dependency>
Spring WebFlux	<dependency> <groupId>com.kalman03</groupId> <artifactId>apideploy-jakarta-swagger3-webflux</artifactId> </dependency>	<dependency> <groupId>com.kalman03</groupId> <artifactId>apideploy-jakarta-javadoc-springweb</artifactId> </dependency>
Apache Dubbo		<dependency> <groupId>com.kalman03</groupId> <artifactId>apideploy-jakarta-javadoc-dubbo</artifactId> </dependency>

2.Config the application.properties or application.yaml.

apideploy.config.enabled=true
apideploy.config.endpoint=https://www.apideploy.cn/openapi/sync
apideploy.config.appId=${appId}
apideploy.config.appSecret=${appSecret}
apideploy.config.autoPublish=true

The ${appId} and ${appSecret} in the configuration file can be applied for free through the apideploy.com website.

For more parameter configuration, please refer to: ：https://doc.apideploy.cn/

3.Run it and see the final result.

The above three steps have completed all the configuration of apideploy. The next step is to write your Javadoc (strongly recommended) or complete the API definition based on Swagger. When everything is ready, run the system locally and the API will be automatically generated and synchronized to the apideploy.com website. Then you can happily check, debug and do version management on apideploy.com .

Samples

For more samples, please refer to apideploy-java-demos.

License

apideploy-java-client is released under the Apache 2.0 license.