Skip to content

Commit 3831a4d

Browse files
committed
Update readme.
1 parent 4858907 commit 3831a4d

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

readme.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
# Summary
55

6-
This library enables use of [json-data] with [Spring Boot]. It enables serialization, validation and error handling for HTTP requests and responses that use JSON entities.
6+
This library enables [json-data] for [Spring Boot] including serialization, validation and error handling for HTTP requests and responses that use JSON entities.
77

88
# Example
99

@@ -71,6 +71,16 @@ class Application {
7171
}
7272
```
7373

74+
# Usage
75+
76+
Use JSON entities with Spring Web and Spring Feign.
77+
78+
Use `ValidateRequest` to validate a JSON entity (the first argument) via JSON Schema. Use `ValidateResponse` to validate a JSON entity (the return value) via JSON Schema.
79+
80+
Use `WrapErrors` to wrap all exceptions in `ServiceException.InternalError` with a given error code, except those that are `ServiceException`.
81+
82+
Provide `CorrelationSource` to enable correlations for error responses.
83+
7484
[json-data]: https://github.com/hrytsenko/json-data
7585
[Spring Boot]: https://spring.io/projects/spring-boot
7686
[Spring Cloud OpenFeign]: https://spring.io/projects/spring-cloud-openfeign

0 commit comments

Comments
 (0)