FromSwaggerToPHPSDK

https://github.com/zpmlabs/from-swagger-to-php-sdk
Admin
A tool to generate a complete PHP SDK from any Swagger/OpenAPI specification with versioned,...
Tokens:1,268
Snippets:3
Trust Score:2.7
Update:1 year ago
Show doc for...
Tokens:
Raw
================
LIBRARY RULES
================
- Parse the Swagger/OpenAPI URL to extract version, tags, operations, schemas, and security schemes.
- Generate a PHP SDK in the `generated-sdk` directory with this structure:
-   - `generated-sdk/`
-     ├── `composer.json`
-     ├── `src/`
-     │   └── `v1/`
-     │       ├── `Services/`
-     │       │   └── `{Tag}Service.php`
-     │       ├── `Models/`
-     │       │   ├── `DTO/`
-     │       │   │   └── `{Model}.php`
-     │       │   └── `Enums/`
-     │       │       └── `{Enum}.php`
-     │       └── `Exceptions/`
-     │           └── `{Exception}.php`
-     ├── `tests/`
-     │   ├── `Unit/v1/Services/`
-     │   │   └── `{Service}Test.php`
-     │   └── `Feature/v1/`
-     │       └── `{Tag}Test.php`
-     └── `README.md`
- Map Swagger types to PHP types as follows: string -> string, integer -> int, boolean -> bool, number -> float, array -> array, object -> {Class}, enum -> {Enum}.
- If securitySchemes include 'type: http' and 'scheme: bearer', add 'private string $apiKey' to service class, include it in constructor, and add 'Authorization: Bearer ' . $apiKey to Guzzle options.
- Use PSR-4 autoloading with namespace derived from Swagger info.title (default to Api\SDK).
- Generate methods with @param, @return, and @throws annotations based on Swagger operation details.
- Create unit tests with mock responses for success and failure cases.
- Ensure all code uses PHP 8.1+ syntax and supports versioning (e.g., v1, v2 folders).

================
CODE SNIPPETS
================
### AI Usage Prompt Example

Source: https://github.com/zpmlabs/from-swagger-to-php-sdk/blob/main/README.md

Provides an example prompt for AI coding assistants to generate a PHP SDK based on the FromSwaggerToPHPSDK instructions, including a placeholder for the API documentation URL.

```TXT
use context7

Generate a PHP SDK using FromSwaggerToPHPSDK instructions:
https://example.com/api/docs/
```

--------------------------------

### Generate PHP Enum

Source: https://github.com/zpmlabs/from-swagger-to-php-sdk/blob/main/README.md

Demonstrates the generation of a PHP 8.1+ native enum from an OpenAPI enum definition. Enums are used for representing a fixed set of constant values.

```PHP
enum Status: string {
    case ACTIVE = 'active';
    case INACTIVE = 'inactive';
}
```

--------------------------------

### Generate PHP Exception

Source: https://github.com/zpmlabs/from-swagger-to-php-sdk/blob/main/README.md

Illustrates the creation of custom PHP exception classes for API error responses, such as '401 Unauthorized'. These exceptions extend a base ApiException class for consistent error handling.

```PHP
class UnauthorizedException extends ApiException
{
    // ... exception details
}
```
Tokens:
Raw