Skip to content

Commit c4a9009

Browse files
committed
docs: Expand Prerequisites to cover non-JSON specs and TypeMapper choices
1 parent 2e02e53 commit c4a9009

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,13 @@ It is designed to be simple to use while providing the essential features needed
1919
## Getting Started
2020

2121
### Prerequisites
22-
- Java SDK 25 or later
23-
- A serialization library, e.g. Gson or Jackson
24-
- OpenAPI specification file in JSON format (`openapi.json`)
22+
- Java SDK 25 or later.
23+
- A JSON library to parse the spec into a `Map<String, Object>`: any of Gson, Jackson, SnakeYAML (for YAML specs), or another mapper of your choice. The library itself doesn't bundle one.
24+
- An OpenAPI 3.1.x specification (`openapi.json` or `openapi.yaml`).
25+
- For `application/json` request/response bodies, either:
26+
- Gson on the classpath — auto-registered via the built-in `GsonJsonMapper` (integer-preserving, JSR-310 written as ISO-8601), or
27+
- a user-supplied `TypeMapper` registered via `Builder.bodyMapper("application/json", mapper)` (e.g. backed by Jackson).
28+
- Built-in mappers for `application/x-www-form-urlencoded` and `text/plain` need no configuration. Any other media type (`application/xml`, `application/cbor`, etc.) requires registering its own `TypeMapper`.
2529

2630

2731
### Basic Usage

0 commit comments

Comments
 (0)