Skip to content

Commit 20839e4

Browse files
authored
Merge pull request #85 from ZenWave360/main
updates documentation for main website compatibility
2 parents 83746d0 + 3b61dac commit 20839e4

File tree

18 files changed

+124
-54
lines changed

18 files changed

+124
-54
lines changed

plugins/asyncapi-generator/README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# AsyncAPI Generator for Java / Spring-Boot
2-
> 👉 ZenWave360 Helps You Create Software Easy to Understand
32

43
[![Maven Central](https://img.shields.io/maven-central/v/io.zenwave360.sdk/zenwave-sdk.svg?label=Maven%20Central&logo=apachemaven)](https://search.maven.org/artifact/io.zenwave360.sdk/zenwave-sdk)
54
[![GitHub](https://img.shields.io/github/license/ZenWave360/zenwave-sdk)](https://github.com/ZenWave360/zenwave-sdk/blob/main/LICENSE)
65

7-
![AsyncAPI and Spring Cloud Streams 3](../../docs/ZenWave360-AsyncAPI-SpringCloudStreams.excalidraw.svg)
6+
![ZenWave AsyncAPI Generator](https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/refs/heads/main/docs/ZenWave360-AsyncAPI-SpringCloudStreams.excalidraw.svg)
87

9-
The ZenWave AsyncAPI Generator solves a long-standing issue in event-driven Java applications: keeping message models and channel contracts fully aligned with their AsyncAPI specification. It provides build-time read-only code generation from AsyncAPI files sourced from their canonical locations: local files, classpath resources, or authenticated remote URLs.
8+
The ZenWave AsyncAPI Generator solves a long-standing issue in event-driven Java applications:
9+
10+
👉 keeping message models and channel contracts fully aligned with their AsyncAPI specification.
11+
12+
It provides build-time read-only code generation from AsyncAPI files sourced from their canonical locations: local files, classpath resources, or authenticated remote URLs.
1013

1114
This approach eliminates API drift by enforcing the AsyncAPI file as the single source of truth for message schemas, channel definitions, and producer or consumer interfaces.
1215

@@ -212,12 +215,7 @@ tasks.register<dev.jbang.gradle.tasks.JBangTask>("generateAsyncApiProvider") {
212215
"--deps=" +
213216
"org.slf4j:slf4j-simple:1.7.36," +
214217
"io.zenwave360.sdk.plugins:asyncapi-generator:RELEASE," +
215-
"org.apache.avro:avro-compiler:1.11.1",
216-
"--java-options \"--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED\"",
217-
"--java-options \"--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED\"",
218-
"--java-options \"--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED\"",
219-
"--java-options \"--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED\"",
220-
"--java-options \"--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED\""
218+
"org.apache.avro:avro-compiler:1.11.1"
221219
))
222220
args.set(listOf(
223221
"-p", "AsyncAPIGenerator",
@@ -255,8 +253,8 @@ sourceSets {
255253
| `role` | Project role: provider/client | AsyncapiRoleType | provider | provider, client |
256254
| `templates` | Templates to use for code generation. | String | SpringCloudStream | SpringCloudStream, SpringKafka, FQ Class Name |
257255
| `modelPackage` | Java Models package name | String | | |
258-
| `producerApiPackage` | Java API package name for outbound (producer) services. It can override apiPackage for producers. | String | {{apiPackage}} | |
259-
| `consumerApiPackage` | Java API package name for inbound (consumer) services. It can override apiPackage for consumer. | String | {{apiPackage}} | |
256+
| `producerApiPackage` | Java API package name for outbound (producer) services. It can override apiPackage for producers. | String | `{{apiPackage}}` | |
257+
| `consumerApiPackage` | Java API package name for inbound (consumer) services. It can override apiPackage for consumer. | String | `{{apiPackage}}` | |
260258
| `apiPackage` | Java API package, if `producerApiPackage` and `consumerApiPackage` are not set. | String | | |
261259
| `operationIds` | Operation ids to include in code generation. Generates code for ALL if left empty | List | [] | |
262260
| `excludeOperationIds` | Operation ids to exclude in code generation. Skips code generation if is not included or is excluded. | List | [] | |

plugins/asyncapi-jsonschema2pojo/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# AsyncAPI and JsonSchema2Pojo (with maven plugin)
2-
> 👉 ZenWave360 Helps You Create Software Easy to Understand
32

43
[![Maven Central](https://img.shields.io/maven-central/v/io.zenwave360.sdk/zenwave-sdk.svg?label=Maven%20Central&logo=apachemaven)](https://search.maven.org/artifact/io.zenwave360.sdk/zenwave-sdk)
54
[![GitHub](https://img.shields.io/github/license/ZenWave360/zenwave-sdk)](https://github.com/ZenWave360/zenwave-sdk/blob/main/LICENSE)
@@ -43,7 +42,7 @@ jbang zw -p io.zenwave360.sdk.plugins.AsyncApiJsonSchema2PojoPlugin --help
4342
You can use ZenWave Maven Plugin to generate code as part of your build process:
4443

4544
- Adding this generator jar as dependency to zenwave maven plugin.
46-
- Passing any configuration as <configOptions>.
45+
- Passing any configuration as `<configOptions>`.
4746

4847
Use jsonschema2pojo prefix to pass any option to https://www.jsonschema2pojo.org/ underlying library.
4948

0 commit comments

Comments
 (0)