@bazo/openapi-client-generator 3.0.13 → 3.0.15

package/README.md

@@ -1,6 +1,6 @@
 # @bazo/openapi-client-generator
 
-Generate type-safe API clients from an OpenAPI / Swagger JSON spec. One CLI, four output targets:
+Generate type-safe API clients from an OpenAPI / Swagger JSON spec. One CLI, five output targets:
 
 | Mode | Output | Stack |
 |------|--------|-------|
@@ -8,6 +8,7 @@ Generate type-safe API clients from an OpenAPI / Swagger JSON spec. One CLI, fou
 | `playwright` | `.ts` | Class wrapping Playwright's `APIRequestContext` for E2E tests + Zod validation |
 | `swift` | `.swift` | `Codable` structs + `async/await` client (Foundation only) |
 | `kotlin` | `.kt` | `@Serializable` data classes + Ktor-based suspend client |
+| `php` | directory of `.php` | PSR-4 classes + backed enums + Symfony HttpClient/Serializer client |
 
 Schemas are normalized, sorted by dependency, and emitted with full types; unused declarations are stripped from TypeScript output automatically.
 
@@ -35,11 +36,13 @@ openapi-client-generator <spec.json> <output-dir> -n <ClientName> [-m <mode>]
 | `<spec.json>` | Path to the OpenAPI/Swagger JSON spec (positional, required) |
 | `<output-dir>` | Directory to write the generated file into (positional, required) |
 | `-n, --name` | Client/class name — must be a valid identifier (required) |
-| `-m, --mode` | `full` \| `playwright` \| `swift` \| `kotlin` (default: `full`) |
+| `-m, --mode` | `full` \| `playwright` \| `swift` \| `kotlin` \| `php` (default: `full`) |
+| `--namespace` | Root PHP namespace, php mode only (default: `--name`) |
+| `--php-version` | Target PHP version, php mode only: `8.0`–`8.5` (default: `8.1`) |
 | `-v, --version` | Print version |
 | `-h, --help` | Print help |
 
-The output file is named after `--name` with the extension chosen by the mode (`MyClient.ts`, `ApiClient.swift`, `ApiClient.kt`).
+The output file is named after `--name` with the extension chosen by the mode (`MyClient.ts`, `ApiClient.swift`, `ApiClient.kt`). The `php` mode instead writes a directory named after `--name` containing one PSR-4 file per class.
 
 ```bash
 # React Query client
@@ -53,6 +56,9 @@ openapi-client-generator api.json Sources/Api -n ApiClient -m swift
 
 # Kotlin client
 openapi-client-generator api.json src/main/kotlin -n ApiClient -m kotlin
+
+# PHP client
+openapi-client-generator api.json src/Api -n ApiClient -m php --namespace "App\\Api" --php-version 8.2
 ```
 
 A handy `package.json` script:
@@ -142,9 +148,25 @@ dependencies {
 }
 ```
 
+### `php` — Symfony HttpClient
+
+Composer dependencies: `symfony/http-client`, `symfony/serializer`, `symfony/property-info`, `symfony/property-access`, `phpdocumentor/reflection-docblock`.
+
+```php
+use App\Api\ApiClient;
+use Symfony\Component\HttpClient\HttpClient;
+
+$api = new ApiClient(HttpClient::create(), 'https://api.example.com');
+$response = $api->listTasks(page: 1, limit: 10);
+$response->data;   // typed model, hydrated via Symfony Serializer
+$response->status; // 200
+```
+
+Constructor: `new ApiClient(HttpClientInterface $client, string $baseUrl, ?SerializerInterface $serializer = null)` (a sensible serializer is built by the generated `SerializerFactory` when omitted). Output is a PSR-4 directory — models under `Model/`, plus `ApiResponse`, `ApiException` (thrown on every non-2xx), and the client class. `--php-version` gates emitted features: backed enums + `readonly` need 8.1+, `readonly class` 8.2+, typed constants 8.3+, `#[\Deprecated]` 8.4+, `#[\NoDiscard]` + `Uri\Rfc3986` URL building 8.5. Code generated for 8.0 uses serializer `^5.4|^6.x` (`AnnotationLoader`); 8.1+ requires serializer >= 6.4.
+
 ## Agent skills
 
-The package ships [agent skills](skills/) — Markdown playbooks for AI coding agents covering CLI usage (`generate-client`) and per-mode integration (`integrate-{full,playwright,swift,kotlin}-client`). Compatible tools discover them automatically once the package is installed.
+The package ships [agent skills](skills/) — Markdown playbooks for AI coding agents covering CLI usage (`generate-client`) and per-mode integration (`integrate-{full,playwright,swift,kotlin,php}-client`). Compatible tools discover them automatically once the package is installed.
 
 ## Development
 
@@ -160,7 +182,7 @@ task run         # generate a sample client from fixtures/api.json into out/
 
 Run a single test file: `bun vitest run src/__tests__/converter/primitives.test.ts`
 
-See [CLAUDE.md](CLAUDE.md) for architecture details and the full task list. `task run-pw`, `task run-swift`, and `task run-kotlin` generate sample clients for the other modes. Runtime integration tests (`task test-runtime`) require a Java/Gradle toolchain (Kotlin) or a Swift toolchain (Swift) and are skipped otherwise.
+See [CLAUDE.md](CLAUDE.md) for architecture details and the full task list. `task run-pw`, `task run-swift`, `task run-kotlin`, and `task run-php` generate sample clients for the other modes. Runtime integration tests (`task test-runtime`) require a Java/Gradle toolchain (Kotlin), a Swift toolchain (Swift), or PHP >= 8.1 + Composer (PHP) and are skipped otherwise.
 
 ## License