apideploy-java8-client 是一个Java系统的API 文档自动生成工具包与apideploy.com网站的部署SDK，它兼容Swagger2（OAS 2.0）, Swagger3 (OAS 3.0), Javadoc规范，支持Java开发框架如 Spring WebMVC, Spring WebFlux 以及Apache Dubbo的文档注释。
注意：该SDK适合使用Java1.8以下版本的系统（仅在1.8版本进行过测试，低于1.8请自行测试），swagger 部分是基于springfox的实现。如果你的系统基于Spring Boot 3.0以上版本，请使用apideploy-jakarta-client。
1.添加Maven依赖到pom.xml：
你得根据你系统的框架选择合适的依赖，以下是maven依赖与框架的对应关系
| / | Spring WebMVC | Spring WebFlux | Apache Dubbo |
|---|---|---|---|
| Swagger2(OAS 2.0) | <dependency> <groupId>com.kalman03</groupId> <artifactId>apideploy-swagger2-webmvc</artifactId> </dependency> | ||
| Swagger3(OAS 3.0) | <dependency> <groupId>com.kalman03</groupId> <artifactId>apideploy-swagger3-webmvc</artifactId> </dependency> | <dependency> <groupId>com.kalman03</groupId> <artifactId>apideploy-swagger3-webflux</artifactId> </dependency> | |
| Javadoc | <dependency> <groupId>com.kalman03</groupId> <artifactId>apideploy-javadoc-springweb</artifactId> </dependency> | <dependency> <groupId>com.kalman03</groupId> <artifactId>apideploy-javadoc-springweb</artifactId> </dependency> |
2.配置application.properties or application.yaml（以下基于springboot的项目application.properties配置示例）：
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配置文件中的${appId}和${appSecret}可以通过apideploy.com网站免费申请。关于详细申请方式，请参考：www。
关于更多参数配置请参考：www
3.运行并查看结果。
以上步骤已经完成所有关于apideploy的配置，接下来就是写你的Javadoc（推荐）或者基于Swagger的方式完成API的定义。当一切就绪，在本地运行该系统，API会自动生成并同步到apideploy网站，接下来就可以在apideploy上愉快的查阅、调试并做版本管理了。
更多使用案例，请参考 apideploy-java-demos.
apideploy-java8-client is released under the Apache 2.0 license.