Skip to content

Commit faf98b5

Browse files
authored
@EnableAsyncApi not necessary anymore, docu snippets removed. (#23)
1 parent 8af37ac commit faf98b5

File tree

5 files changed

+8
-24
lines changed

5 files changed

+8
-24
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
node_modules
22
.docusaurus
3-
build/**
3+
build/**
4+
.idea

docs/configuration.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,10 @@ import CodeConfigurationAsyncApiDocket from '!!raw-loader!./snippets/_configurat
1111

1212
## Activating
1313

14-
- You need to provide a configuration class annotated with:
15-
1. `@Configuration`
16-
2. `@EnableAsyncApi`
17-
- The name of the class does no matter. You don't have to, but it is a good idea to name the class related to Springwolf or AsyncApi.
14+
Springwolf is actived automatically as soon as one of the available plugin dependencies (e.g. `springwolf-kafka`)
15+
is added to the application classpath.
16+
1817

19-
```java
20-
@Configuration
21-
@EnableAsyncApi
22-
public class AsyncApiConfiguration { }
23-
```
2418

2519
## Springwolf configuration
2620

@@ -35,7 +29,7 @@ There are 2 ways to configure springwolf:
3529
<CodeBlock language="properties">{CodeConfigurationProperties}</CodeBlock>
3630
</TabItem>
3731
<TabItem value="AsyncApiDocket" label="AsyncApiDocket">
38-
Add a AsyncApiDocket bean to the spring context, for example as part of the AsyncApiConfiguration.
32+
Add a AsyncApiDocket bean to the spring context.
3933
<CodeBlock language="java">{CodeConfigurationAsyncApiDocket}</CodeBlock>
4034
</TabItem>
4135
</Tabs>
@@ -72,4 +66,4 @@ The following table contains additional properties that can be specified in the
7266
| `springwolf.plugin.kafka.publishing.enabled` | `false` | Allow (anyone) to produce kafka messages from the UI. *Note that this has security implications* |
7367

7468
[info]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#infoObject.
75-
[server]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#serversObject
69+
[server]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#serversObject

docs/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public class ExampleConsumer {
3434
}
3535
```
3636

37-
By simply adding Springwolf dependency and a short configuration class to your project you will automatically get:
37+
By simply adding Springwolf dependency to your project you will automatically get:
3838
- An endpoint returning an asyncapi document describing your async API.
3939
- A web UI for convenient use by your developers, QA or clients of your async API.
4040
- An easy way to publish messages to your async API with a click of a button

docs/quickstart.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,6 @@ Latest version:
3030
![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-kafka?color=green&label=springwolf-kafka&style=plastic)
3131
![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-ui?color=green&label=springwolf-ui&style=plastic)
3232

33-
## Configuration Class
34-
35-
Add the following configuration class:
36-
37-
```java
38-
@Configuration
39-
@EnableAsyncApi
40-
public class AsyncApiConfiguration { }
41-
```
42-
4333
## Configuration properties
4434

4535
Add the following to your application.properties

docs/snippets/_configuration_asyncApiDocket.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
@Configuration
2-
@EnableAsyncApi
32
public class AsyncApiConfiguration {
43

54
private final String BOOTSTRAP_SERVERS;

0 commit comments

Comments
 (0)