Merge pull request #18 from crescat-io/feature/develop

DTO Generator + tests

Author: HelgeSverre

README.md

@@ -31,6 +31,8 @@ composer global require crescat-io/saloon-sdk-generator
 
 ## Usage
 
+### Generate SDK from OpenAPI or Postman Collection
+
 To generate the PHP SDK from an API specification file, run the following command:
 
 ```shell
@@ -67,6 +69,25 @@ sdkgenerator generate:sdk ./tests/Samples/paddle.json
   --namespace=Your\\Sdk\\Namespace # <-- Note the "\\"
 ```
 
+## Converting Swagger v1 or v2 definitions to the OpenAPI 3.0 format
+
+For convenience, we've included a command that allows you to convert Swagger v1 or v2 definitions to the OpenAPI 3.0
+The command will send your api definition file to the [Swagger Converter API](https://converter.swagger.io/) and save the output in the specified path.
+
+if no output file is specified, the output location will be the original filepath with the `.converted.json` extension.
+
+To use it, run the following command:
+
+```shell
+sdkgenerator convert old.json [output.json]
+
+## e.g.
+sdkgenerator convert tests/Samples/tripletex.json tests/Samples/tripletex.converted.json
+```
+
+Only OpenAPI is supported for now.
+
+
 ## Using the Code Generator and Parser Programmatically
 
 1. **Configure Your Generator:**

builds/sdkgenerator

@@ -14,20 +14,21 @@
         }
     ],
     "require": {
-        "php": "^8.1",
+        "php": "^8.2",
         "ext-zip": "*",
         "cebe/php-openapi": "^1.7",
         "laravel-zero/phar-updater": "^1.3",
         "nette/php-generator": "^4.0",
         "nunomaduro/termwind": "^1.15.1",
+        "saloonphp/laravel-plugin": "^3.2",
         "saloonphp/saloon": "^3.0",
-        "saloonphp/laravel-plugin": "^3.0"
+        "spatie/laravel-data": "^3.10"
     },
     "require-dev": {
-        "laravel-zero/framework": "^10.0.2",
-        "laravel/pint": "^1.8",
+        "laravel-zero/framework": "^10.3.0",
+        "laravel/pint": "^1.13",
         "mockery/mockery": "^1.5.1",
-        "pestphp/pest": "^2.5"
+        "pestphp/pest": "^2.28.0"
     },
     "autoload": {
         "psr-4": {
@@ -40,26 +41,22 @@
         }
     },
     "scripts": {
-        "build": "php ./codegen app:build sdkgenerator --build-version=1.0",
+        "build": "php ./codegen app:build sdkgenerator --build-version=1.1",
         "clean": "rm -rf ./tests/Output/*",
         "generate:fiken": "./codegen generate:sdk --force --namespace=Crescat\\\\Fiken --type=openapi --name=Fiken tests/Samples/fiken.yml --output tests/Output/Fiken",
-        "generate:gocardless": "./codegen generate:sdk --force --namespace=Crescat\\\\GoCardless --type=openapi --name=GoCardlessBankAccountData tests/Samples/gocardless.json --output tests/Output/GoCardless",
+        "generate:gocardless": "./codegen generate:sdk --force --namespace=Crescat\\\\GoCardless --type=openapi --name=GoCardless tests/Samples/gocardless.json --output tests/Output/GoCardless",
         "generate:openai": "./codegen generate:sdk --force --namespace=Crescat\\\\OpenAI --type=postman --name=OpenAI tests/Samples/openai.json --output tests/Output/Openai",
         "generate:paddle": "./codegen generate:sdk --force --namespace=Crescat\\\\Paddle --type=postman --name=Paddle tests/Samples/paddle.json --output tests/Output/Paddle",
         "generate:stripe": "./codegen generate:sdk --force --namespace=Crescat\\\\Stripe --type=postman --name=Stripe tests/Samples/stripe.json --output tests/Output/Stripe",
         "generate:tableau": "./codegen generate:sdk --force --namespace=Crescat\\\\Tableau --type=postman --name=Tableau tests/Samples/tableau.json --output tests/Output/Tableau",
-        "generate:tripletex": "./codegen generate:sdk --force --namespace=Crescat\\\\Tripletex --type=openapi --name=Tripletex tests/Samples/tripletex.json --output tests/Output/Tripletex",
+        "generate:tripletex": "./codegen generate:sdk --force --namespace=Crescat\\\\Tripletex --type=openapi --name=Tripletex tests/Samples/tripletex.converted.json --output tests/Output/Tripletex",
         "generate:checkmango": "./codegen generate:sdk --force --namespace=Checkmango\\\\Sdk --type=openapi --name=Checkmango tests/Samples/checkmango.json --output tests/Output/Checkmango",
         "generate:kassalapp": "./codegen generate:sdk --force --namespace=Kassalapp\\\\Sdk --type=openapi --name=Kassalapp tests/Samples/kassalapp.json --output tests/Output/Kassalapp",
         "generate:altinn": "./codegen generate:sdk --force --namespace=Altinn\\\\Sdk --type=postman --name=Altinn tests/Samples/altinn.json --output tests/Output/Altinn",
         "generate:crescat": "./codegen generate:sdk --force --namespace=Crescat\\\\Sdk --type=openapi --name=Crescat tests/Samples/crescat.yaml --output tests/Output/Crescat",
-        "generate:zip:fiken": "./codegen generate:sdk --force --type=openapi --name=Fiken tests/Samples/fiken.yml --output tests/Output --zip",
-        "generate:zip:gocardless": "./codegen generate:sdk --force --type=openapi --name=GoCardlessBankAccountData tests/Samples/gocardless.json --output tests/Output --zip",
-        "generate:zip:openai": "./codegen generate:sdk --force --type=postman --name=OpenAI tests/Samples/openai.json --output tests/Output --zip",
-        "generate:zip:paddle": "./codegen generate:sdk --force --type=postman --name=Paddle tests/Samples/paddle.json --output tests/Output --zip",
-        "generate:zip:stripe": "./codegen generate:sdk --force --type=postman --name=Stripe tests/Samples/stripe.json --output tests/Output --zip",
-        "generate:zip:tableau": "./codegen generate:sdk --force --type=postman --name=Tableau tests/Samples/tableau.json --output tests/Output --zip",
-        "generate:zip:tripletex": "./codegen generate:sdk --force --type=openapi --name=Tripletex tests/Samples/tripletex.json --output tests/Output --zip",
+        "generate:bigcommerce": "./codegen generate:sdk --force --namespace=BigCommerce\\\\Sdk --type=openapi --name=BigCommerce tests/samples/bigcommerce_abandoned_carts.v3.yml --output tests/Output/BigCommerce",
+        "generate:vegvesen": "./codegen generate:sdk --force --namespace=Vegvesen\\\\Sdk --type=openapi --name=Vegvesen tests/samples/vegvesen.json --output tests/Output/Vegvesen",
+        "generate:spotify": "./codegen generate:sdk --force --namespace=Spotify\\\\Sdk --type=openapi --name=Spotify tests/samples/spotify.yml --output tests/Output/Spotify",
         "generate:all": [
             "@generate:fiken",
             "@generate:gocardless",
@@ -70,9 +67,10 @@
             "@generate:stripe",
             "@generate:checkmango",
             "@generate:kassalapp",
-            "@generate:crescat"
+            "@generate:crescat",
+            "@generate:bigcommerce"
         ],
-        "test": "vendor/bin/pest",
+        "test": "vendor/bin/pest tests",
         "test-coverage": "vendor/bin/pest --coverage",
         "format": "vendor/bin/pint"
     },