Download the PHP package appwrite/sdk-generator without Composer
On this page you can find all versions of the php package appwrite/sdk-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download appwrite/sdk-generator
More information about appwrite/sdk-generator
Files in appwrite/sdk-generator
Package sdk-generator
Short Description Appwrite PHP library for generating API SDKs for multiple programming languages and platforms
License MIT
Informations about the package sdk-generator
⚙️ Appwrite SDK Generator
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
Docker (UNIX)
Docker (Windows)
Create language and SDK instances and generate code to target directory.
For generated artifacts that do not need an API specification, use StaticSpec:
Linting Twig Templates
This project uses djLint to lint Twig template files for syntax and common issues.
Note: Formatting is disabled as it breaks code generation syntax. Only linting is used.
Available command:
Requires uv to be installed. Configuration is in pyproject.toml. The linter runs automatically on pull requests via GitHub Actions.
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)
Generated SDKs and Artifacts
The primary generation targets are defined in example.php. Run it without arguments to generate every target with the default console platform spec, or pass a target and optional platform to generate one SDK:
<platform> can be console, client, or server. If omitted, it defaults to console.
Examples:
Client SDKs
| Target | Argument | Supported Versions | Coding Standards | Package Manager | Output |
|---|---|---|---|---|---|
| Web | web |
ES5+; Node.js >=18 for builds | NPM Coding Style | NPM | examples/web/ |
| Flutter | flutter |
Dart >=2.17 <4; Flutter stable | Effective Dart | pub | examples/flutter/ |
| Apple | apple |
iOS 15+, macOS 11+, watchOS 7+, tvOS 13+ | Swift Style Guide | Swift Package Manager | examples/apple/ |
| Android | android |
Android 5.0+; Java 17 in CI | Android style guide | Gradle, Maven | examples/android/ |
| React Native | react-native |
React Native >=0.76.7 <1.0.0; Node.js >=18 | NPM Coding Style | NPM | examples/react-native/ |
Server SDKs
| Target | Argument | Supported Versions | Coding Standards | Package Manager | Output |
|---|---|---|---|---|---|
| Node.js | node |
Node.js 20 in CI | NPM Coding Style | NPM | examples/node/ |
| PHP | php |
PHP >=8.2 | PHP FIG | Composer | examples/php/ |
| Python | python |
Python >=3.9 | PEP8 | pip | examples/python/ |
| Ruby | ruby |
Ruby 3.1 in CI | Ruby Style Guide | RubyGems, Bundler | examples/ruby/ |
| Dart | dart |
Dart >=2.17 <4 | Effective Dart | pub | examples/dart/ |
| Go | go |
Go 1.22.5 | Effective Go | Go modules | examples/go/ |
| Swift | swift |
Swift 5.1+; Swift 5.9.2 in CI | Swift Style Guide | Swift Package Manager | examples/swift/ |
| .NET | dotnet |
.NET Standard 2.0; .NET Framework 4.6.2 | C# Coding Conventions | NuGet | examples/dotnet/ |
| Kotlin | kotlin |
JVM 1.8 target; Java 17 in CI | Kotlin style guide | Gradle, Maven | examples/kotlin/ |
| Rust | rust |
Rust >=1.83 | Rust API Guidelines | Cargo | examples/rust/ |
Tooling and Documentation
| Target | Argument | Supported Versions | Coding Standards | Package Manager | Output |
|---|---|---|---|---|---|
| CLI | cli |
Node.js 20 and Bun 1.3.11 in CI | NPM Coding Style | NPM, Bun, native binaries | examples/cli/ |
| REST examples | rest |
N/A | Markdown | N/A | examples/REST/ |
| GraphQL | graphql |
N/A | GraphQL | N/A | examples/graphql/ |
| Markdown docs | markdown |
N/A | Markdown | N/A | examples/markdown/ |
| Agent Skills | agent-skills |
N/A | Markdown | N/A | examples/agent-skills/ |
| Cursor Plugin | cursor-plugin |
N/A | Markdown | N/A | examples/cursor-plugin/ |
| Claude Plugin | claude-plugin |
N/A | Markdown | N/A | examples/claude-plugin/ |
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
All versions of sdk-generator with dependencies
ext-curl Version *
ext-mbstring Version *
ext-json Version *
twig/twig Version 3.27.*
matthiasmullie/minify Version 1.3.*