Merge pull request #124 from DoclerLabs/openapi3.1

openapi 3.1

Author: vsouz4

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [11.0.0] - 2025.04.21
+### Added
+- Support for OpenAPI 3.1
+
+### Changed
+- cebe/php-openapi dependency to devizzent/cebe-php-openapi
+
 ## [10.10.1] - 2025.02.19
 ### Fixed
 - avoid having `&` in request body when using `application/x-www-form-urlencoded`

composer.json

@@ -18,7 +18,7 @@
     "ext-dom": "*",
     "ext-json": "*",
     "ext-xml": "*",
-    "cebe/php-openapi": "^1.4",
+    "devizzent/cebe-php-openapi": "^1.1",
     "docler-labs/api-client-exception": "^1.0.1 || ^2.0",
     "friendsofphp/php-cs-fixer": "^3.0",
     "guzzlehttp/psr7": "^1.6",

composer.lock

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenApi\PetStoreApiConsumer;
+
+use GuzzleHttp\Client;
+use OpenApi\PetStoreClient\Request\DeletePetRequest;
+use OpenApi\PetStoreClient\Request\FindPetsByStatusRequest;
+use OpenApi\PetStoreClient\Request\GetPetByIdRequest;
+use OpenApi\PetStoreClient\Request\UpdatePetRequest;
+use OpenApi\PetStoreClient\Schema\Pet;
+use OpenApi\PetStoreClient\SwaggerPetstoreOpenAPI31ClientFactory;
+use UnexpectedValueException;
+
+class PetStoreApiConsumer
+{
+    private $petClient;
+
+    public function __construct()
+    {
+        $this->petClient = (new SwaggerPetstoreOpenAPI31ClientFactory())
+            ->create(new Client(['base_uri' => 'http://pet.wiremock:8080']));
+    }
+
+    public function findPetsByStatus(): Pet
+    {
+        $request = new FindPetsByStatusRequest();
+        $request->setStatus('sold');
+        $result = $this->petClient->findPetsByStatus($request);
+        if ($result === null || $result->count() === 0) {
+            throw new UnexpectedValueException('findPetsByStatus should be not null or empty');
+        }
+
+        return $result->first();
+    }
+
+    public function getPetById(int $petId, string $apiKey): Pet
+    {
+        $request = new GetPetByIdRequest($petId, $apiKey);
+        $result  = $this->petClient->getPetById($request);
+        if ($result === null) {
+            throw new UnexpectedValueException('getPetById should not be null');
+        }
+
+        return $result;
+    }
+
+    public function updatePet(Pet $pet, string $mimeType): void
+    {
+        $request = new UpdatePetRequest($pet, $mimeType);
+        $result  = $this->petClient->updatePet($request);
+        if ($result === null) {
+            printf('getPetById failed, result: %s', json_encode($result, JSON_THROW_ON_ERROR)) || exit(1);
+        }
+    }
+
+    public function deletePet(int $petId): void
+    {
+        $request = new DeletePetRequest($petId);
+        $this->petClient->deletePet($request);
+    }
+}

example3_1/PetStoreApiConsumer/PetStoreApiConsumer.php

@@ -0,0 +1,68 @@
+# Swagger Petstore - OpenAPI 3.1 client
+
+This client is generated using [docler-labs/api-client-generator](https://github.com/DoclerLabs/api-client-generator) based on the OpenAPI specification of the Swagger Petstore - OpenAPI 3.1.
+
+You can generate the client with the following command:
+```bash
+docker run -it --rm \
+-v <local-path-to-api>/doc/openapi.yaml:/openapi.yaml:ro \
+-v <local-path-to-client>:/client \
+-e NAMESPACE=OpenApi\\PetStoreClient \
+-e OPENAPI=/openapi.yaml \
+-e OUTPUT_DIR=/client \
+-e PACKAGE=openapi/pet-store-client \
+-e CLIENT_PHP_VERSION=7.4 \
+dhlabs/api-client-generator
+```
+
+## Usage
+
+```php
+<?php declare(strict_types=1);
+
+use OpenApi\PetStoreClient\SwaggerPetstoreOpenAPI31ClientFactory;
+use OpenApi\PetStoreClient\Request\UpdatePetRequest;
+
+/**
+ * If using Guzzle 6, make sure to configure Guzzle to not throw exceptions
+ * on HTTP error status codes, or this client will violate PSR-18.
+ * e.g. new Client(['base_uri' => $baseUri, 'http_errors' => false, ...])
+ */
+$client = ...; // any PSR-18 HTTP CLIENT
+
+$factory = new SwaggerPetstoreOpenAPI31ClientFactory();
+$client  = $factory->create($client);
+
+$request = new UpdatePetRequest();
+$result  = $client->updatePet($request);
+```
+
+## Operations
+
+### pet
+Endpoints:
+- **updatePet** - Update an existing pet by Id
+- **addPet** - Add a new pet to the store
+- **findPetsByStatus** - Multiple status values can be provided with comma separated strings
+- **findPetsByTags** - Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+- **getPetById** - Returns a single pet
+- **updatePetWithForm**
+- **deletePet**
+
+### store
+Endpoints:
+- **getInventory** - Returns a map of status codes to quantities
+- **placeOrder** - Place a new order in the store
+- **getOrderById** - For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values will generated exceptions
+- **deleteOrder** - For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
+
+### user
+Endpoints:
+- **createUser** - This can only be done by the logged in user.
+- **createUsersWithListInput** - Creates list of users with given input array
+- **loginUser**
+- **logoutUser**
+- **getUserByName**
+- **updateUser** - This can only be done by the logged in user.
+- **deleteUser** - This can only be done by the logged in user.
+

example3_1/PetStoreClient/README.md

@@ -0,0 +1,30 @@
+{
+    "name": "openapi/pet-store-client",
+    "description": "Client library for Swagger Petstore - OpenAPI 3.1",
+    "license": "Apache 2.0",
+    "keywords": [
+        "api-client"
+    ],
+    "config": {
+        "sort-packages": true
+    },
+    "require": {
+        "php": "^7.4 || ^8.0",
+        "docler-labs/api-client-exception": "^1.0 || ^2.0",
+        "ext-dom": "*",
+        "ext-json": "*",
+        "guzzlehttp/psr7": "^1.6 || ^2.6",
+        "pimple/pimple": "^3.5",
+        "psr/container": "^1.0 || ^2.0",
+        "psr/http-client": "^1.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "OpenApi\\PetStoreClient\\": "src/"
+        }
+    },
+    "suggest": {
+        "guzzlehttp/guzzle": "PSR-18 provided by Guzzle 7",
+        "php-http/guzzle6-adapter": "PSR-18 wrapper for Guzzle 6"
+    }
+}