appwrite/sdk-generator

Appwrite PHP library for generating API SDKs for multiple programming languages and platforms

0.39.25 2024-11-08 10:16 UTC

Requires

• php: >=8.3
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• matthiasmullie/minify: 1.3.*
• twig/twig: 3.14.*

Requires (Dev)

• brianium/paratest: 7.*
• phpunit/phpunit: 11.*
• squizlabs/php_codesniffer: 3.*

MIT

• Eldad Fux

README

WORK IN PROGRESS - NOT READY FOR GENERAL USAGE

Appwrite SDK generator is a PHP library for auto-generating SDK libraries for multiple languages and platforms.

The SDK Generator uses predefined language settings as Twig templates to generate codebases based on different API specs.

Currently, the only spec supported is Swagger 2.0, but we intend to add support for more specifications in the near future. This generator is still lacking support for any definition/model specs.

Getting Started

Install using composer:

CLI

composer update --ignore-platform-reqs --optimize-autoloader

Docker (UNIX)

docker run --rm --interactive --tty --volume "$(pwd)":/app composer install --ignore-platform-reqs

Docker (Windows)

docker run --rm --interactive --tty --volume "%cd%":/app composer install --ignore-platform-reqs

Create language and SDK instances and generate code to target directory.

<?php

require_once 'vendor/autoload.php';

use Appwrite\Spec\Swagger2;
use Appwrite\SDK\SDK;
use Appwrite\SDK\Language\PHP;

// Read API specification file (Swagger 2) and create spec instance
$spec = new Swagger2(file_get_contents('https://appwrite.io/v1/open-api-2.json?extension=1'));

// Create language instance
$lang = new PHP();

$lang // Set language or platform specific options
    ->setComposerPackage('my-api')
    ->setComposerVendor('my-company')
;

// Create the SDK object with the language and spec instances
$sdk  = new SDK($lang, $spec);

$sdk
    ->setLogo('https://appwrite.io/v1/images/console.png')
    ->setLicenseContent('License content here.')
    ->setVersion('v1.1.0')
;

$sdk->generate(__DIR__ . '/examples/php'); // Generate source code

Supported Specs

• Swagger 2
• OpenAPI 3 (Not Ready)
• RAML 1.0 (Not Ready)
• RAML 0.8 (Not Ready)
• Postman 2.0 (Not Ready)
• Postman 1.0 (Not Ready)
• API Blueprint 1A (Not Ready)

Supported Client / Platform SDKs

Supported Server SDKs

Contributing

All code contributions, including those by people with commit access, must go through a pull request and be approved by a core developer before being merged. This is to ensure proper review of all the code.

We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the contribution guide.

Copyright and license

The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php