JSON:API PHP SDK Generator

Generate a PHP SDK for API's using JSON:API

./bin/jsonapi-sdk generate \
    --output=../my-sdk/ \
    --namespace="MySdk" \
    --connector-name "MyConnector" \
    --tests \
    --factories \
    ./openapi.json

For more information on the command options run jsonapi-sdk generate --help. It will list all these command options:

Options:
  -o, --output=OUTPUT                  Output directory for generated SDK [default: "./output"]
      --namespace=NAMESPACE            Root namespace for generated code [default: "App\Sdk"]
  -c, --connector-name=CONNECTOR-NAME  Name of the Connector class [default: "ApiConnector"]
  -t, --tests                          Generate Pest tests
  -f, --factories                      Generate Faker factories  
      --foundation                     Generate Foundation support files
      --dry-run                        Show what would be generated without writing files
      --force                          Overwrite existing files
      --config-key=CONFIG-KEY          Laravel config key for the SDK (e.g., "myapi" results in config("myapi.base_url"))
      --base-url=BASE-URL              Default base URL for the API [default: "https://api.example.com"]

When you run the command for the first time, you should add the --foundation flag. This will add all the necessary files that are 'static' and these can be changed manually afterward.

Recommended first-time setup

1. Create your project, e.g. git init
2. Initialize Composer composer init, this generator depends on the psr-4 autoload namespace and the package name.
3. Then run the generator with --foundation.

What --foundation does comes down to:

• Verifies a composer.json exists and checks if it contains a PSR-4 autoload section.
• Runs composer require to add runtime dependencies like saloonphp/saloon, nesbot/carbon, saloonphp/pagination-plugin
• Runs composer require --dev to add development dependencies like: faker,pest, pint and larastan
• Updates your composer.json with PSR-4 autoload mappings
• Adds composer scripts test, coverage, format and analyse
• Enables the Pest plugin in config.allow-plugins.