Polish "Document `@EmbeddedKafka` and its interaction with Spring Boot"

See gh-15834
This commit is contained in:
Andy Wilkinson 2019-07-23 17:18:59 +01:00
parent 4e79408bb0
commit e7b94be9cd
1 changed files with 7 additions and 6 deletions

View File

@ -6286,13 +6286,13 @@ explicitly supports.
[[boot-features-embedded-kafka]]
==== Testing with Embedded Kafka
Spring for Apache Kafka provides a convenient way to test projects with an embedded Apache Kafka
broker. This feature is available via an `@EmbeddedKafka` test class level annotation from the
`spring-kafka-test` dependency. See more information in the Spring for Apache Kafka
broker. To use this feature, annotate a test class with `@EmbeddedKafka` from the `spring-kafka-test`
module. For more information, please see the Spring for Apache Kafka
https://docs.spring.io/spring-kafka/docs/current/reference/html/#embedded-kafka-annotation[reference manual].
To make Spring Boot auto-configuration work with the mentioned embedded Apache Kafka broker, you need
To make Spring Boot auto-configuration work with the aforementioned embedded Apache Kafka broker, you need
to remap a system property for embedded broker addresses (populated by the `EmbeddedKafkaBroker`)
into Spring Boot configuration property for Apache Kafka. There are several ways to do that:
into the Spring Boot configuration property for Apache Kafka. There are several ways to do that:
* Provide a system property to map embedded broker addresses into `spring.kafka.bootstrap-servers` in the test class:
@ -6303,7 +6303,7 @@ static {
}
----
* Configuring a property name on the `@EmbeddedKafka` annotation:
* Configure a property name on the `@EmbeddedKafka` annotation:
[source,java,indent=0]
----
@ -6311,7 +6311,7 @@ static {
bootstrapServersProperty = "spring.kafka.bootstrap-servers")
----
* Via placeholders in configuration properties:
* Use a placeholder in configuration properties:
[source,properties,indent=0]
----
@ -6319,6 +6319,7 @@ spring.kafka.bootstrap-servers=${spring.embedded.kafka.brokers}
----
[[boot-features-resttemplate]]
== Calling REST Services with `RestTemplate`
If you need to call remote REST services from your application, you can use the Spring