Skip to content

Commit 01d9995

Browse files
Carlos Tasadatimonback
authored andcommitted
Updated Docket configuration
Updated configuration to reflect changes at https://github.com/springwolf/springwolf-core/pull/191/files
1 parent 575e8ab commit 01d9995

File tree

4 files changed

+20
-0
lines changed

4 files changed

+20
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ The [docs](docs) folder contains all pages in Markdown format.
1414

1515
### Local Development
1616

17+
```bash
18+
npm install
19+
```
20+
Make sure that you have installed all the dependencies in your local environment. You only need to run this command the first time
21+
or after dependencies are updated.
22+
1723
```bash
1824
npm start
1925
```

docs/configuration/configuration.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ It is recommended to structure the project such that all consumers and producers
3333

3434
The base package will be scanned for classes containing `@Component` annotated classes (that includes `@Service` annotated classes) for methods annotated with `@KafkaListener`, `@RabbitListener`, `@AsyncListener`, `@AsyncPublisher`, etc.
3535

36+
### id
37+
38+
The `Identifier` value represents a unique universal identifier of the application. See [Identifier][identifier].
39+
40+
### default-content-type
41+
42+
A string representing the default content type to use when encoding/decoding a message's payload. See [Default Content Type][default-content-type]
43+
3644
### Info (required)
3745

3846
The `Info` object provides metadata about the API (see [Info Object][info]).
@@ -67,5 +75,7 @@ The following table contains additional properties that can be specified in the
6775
| `springwolf.plugin.kafka.publishing.producer` | `null` | Configure the kafka producer used to publish messages from the UI. Uses identical parameters as `spring.kafka.producer` |
6876
| `springwolf.plugin.kafka.scanner.kafka-listener.enabled` | `true` | Enable scanner to find methods annotated with `@KafkaListener`. |
6977

78+
[identifier]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#A2SIdString.
7079
[info]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#infoObject.
7180
[server]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#serversObject
81+
[default-content-type]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#defaultContentTypeString

docs/configuration/snippets/_configuration_asyncApiDocket.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ public class AsyncApiConfiguration {
2626
return AsyncApiDocket.builder()
2727
.basePackage("io.github.stavshamir.springwolf.example.consumers")
2828
.info(info)
29+
.id("urn:io:github:stavshamir:springwolf:example")
30+
.defaultContentType("application/json")
2931
.server("kafka", Server.builder()
3032
.protocol("kafka")
3133
.url(BOOTSTRAP_SERVERS)

docs/configuration/snippets/_configuration_properties.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
springwolf.docket.base-package=io.github.stavshamir.springwolf.example
2+
springwolf.docket.id=urn:io:github:stavshamir:springwolf:example
3+
springwolf.docket.default-content-type=application/json
24

35
springwolf.docket.info.title=${spring.application.name}
46
springwolf.docket.info.version=1.0.0

0 commit comments

Comments
 (0)