|
1 | | -# net.qtsurfer:api-client |
| 1 | +<h1 align="center">QTSurfer API Client · Java</h1> |
2 | 2 |
|
3 | 3 | <p align="center"> |
4 | 4 | <a href="https://github.com/QTSurfer/api-client-java/actions/workflows/ci.yml"><img src="https://github.com/QTSurfer/api-client-java/actions/workflows/ci.yml/badge.svg" alt="CI"></a> |
5 | 5 | <a href="https://jitpack.io/#QTSurfer/api-client-java"><img src="https://jitpack.io/v/QTSurfer/api-client-java.svg" alt="JitPack"></a> |
| 6 | + <img src="https://img.shields.io/badge/JDK-17%2B-blue?logo=openjdk&logoColor=white" alt="JDK 17+"> |
6 | 7 | <a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License"></a> |
7 | 8 | </p> |
8 | 9 |
|
9 | | -Auto-generated Java API client for the [QTSurfer API](https://github.com/QTSurfer/qtsurfer-api), produced from the OpenAPI 3.1 spec with [openapi-generator](https://openapi-generator.tech) and the `java` + `native` library (JDK `java.net.http.HttpClient`). |
| 10 | +<p align="center"> |
| 11 | + Auto-generated Java client for the <a href="https://github.com/QTSurfer/qtsurfer-api">QTSurfer API</a>, built from the OpenAPI 3.1 spec with <a href="https://openapi-generator.tech">openapi-generator</a> and the JDK's <code>java.net.http.HttpClient</code>. |
| 12 | +</p> |
| 13 | + |
| 14 | +<p align="center"> |
| 15 | + <code>net.qtsurfer:api-client</code> · <code>com.github.QTSurfer:api-client-java</code> |
| 16 | +</p> |
| 17 | + |
| 18 | +--- |
10 | 19 |
|
11 | | -This package is intentionally thin: one method per endpoint, 1:1 with the spec. For workflow orchestration (polling, retries, domain objects, unified errors), use [`net.qtsurfer:sdk`](https://github.com/QTSurfer/sdk-java). |
| 20 | +Intentionally thin: one method per endpoint, 1:1 with the spec. For workflow orchestration (polling, retries, domain objects, unified errors), use [`net.qtsurfer:sdk`](https://github.com/QTSurfer/sdk-java). |
12 | 21 |
|
13 | | -- `java.net.http.HttpClient`-based; zero HTTP runtime dependencies beyond Jackson. |
14 | | -- Generated sources are written to `target/generated-sources/openapi` on every build (spec fetched from `main` of [`QTSurfer/qtsurfer-api`](https://github.com/QTSurfer/qtsurfer-api)). |
15 | | -- Requires **JDK 17+**. |
| 22 | +- **Zero HTTP runtime deps** — `java.net.http.HttpClient` (JDK built-in) + Jackson for JSON. |
| 23 | +- **Spec-driven** — generated sources fetched from [`QTSurfer/qtsurfer-api`](https://github.com/QTSurfer/qtsurfer-api) on every build. |
| 24 | +- **JDK 17+** — modern language features, long-term support. |
| 25 | +- **Distributed via JitPack** today; Maven Central later. |
16 | 26 |
|
17 | 27 | ## Installation |
18 | 28 |
|
|
0 commit comments