Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/appwrite/sdk-generator

Generating SDKs for multiple programming languages and platforms ⚙️
https://github.com/appwrite/sdk-generator

dart flutter hacktoberfest javascript js kotlin multiple-languages nodejs php python ruby sdk-generator swift web

Last synced: about 1 month ago
JSON representation

Generating SDKs for multiple programming languages and platforms ⚙️

Host: GitHub
URL: https://github.com/appwrite/sdk-generator
Owner: appwrite
License: mit
Created: 2019-05-22T16:47:41.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-04-12T10:33:21.000Z (5 months ago)
Last Synced: 2024-04-12T14:30:21.199Z (5 months ago)
Topics: dart, flutter, hacktoberfest, javascript, js, kotlin, multiple-languages, nodejs, php, python, ruby, sdk-generator, swift, web
Language: Twig
Homepage: https://appwrite.io
Size: 21.9 MB
Stars: 246
Watchers: 23
Forks: 153
Open Issues: 52
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # ⚙️ Appwrite SDK Generator

[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)

[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)

[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)

[![Follow Appwrite on StackShare](https://img.shields.io/badge/follow%20on-stackshare-blue?style=flat-square)](https://stackshare.io/appwrite)

[![appwrite.io](https://img.shields.io/badge/appwrite-.io-f02e65?style=flat-square)](https://appwrite.io)

**WORK IN PROGRESS - NOT READY FOR GENERAL USAGE**

[Appwrite](https://appwrite.io) 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](https://twig.symfony.com/) 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**

```bash

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

```

**Docker (UNIX)**

```bash

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

```

**Docker (Windows)**

```bash

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

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](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md)

* [OpenAPI 3](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md) (Not Ready)

* [RAML 1.0](https://raml.org/) (Not Ready)

* [RAML 0.8](https://raml.org/) (Not Ready)

* [Postman 2.0](https://schema.getpostman.com/json/collection/v2.0.0/docs/index.html) (Not Ready)

* [Postman 1.0](https://schema.getpostman.com/json/collection/v1.0.0/docs/index.html) (Not Ready)

* [API Blueprint 1A](https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md) (Not Ready)

## Supported Client / Platform SDKs

| Language               | Supported Versions  |  Coding Standards      |  Package Manager   |   Maintainer   |

|------------------------|---------------------|------------------------|--------------------|----------------|

| Web                    | ES5+                | [NPM Coding Style]     | NPM, Yarn,         | [@eldadfux]    |

| Flutter                |                     | [Effective Dart]       | pub tool           | [@bartektartanus] [@Almoullim] [@lohanidamodar]   |

| Android (Kotlin, Java) | 5.0+                | [Android style guide]  | Gradle, Maven      | [@abnegate]    |

| iOS, macOS (Swift)     | iOS 15+, macOS 11+  | [Swift Style Guide]    | Swift Pkg Manager  | [@abnegate]    |

| Unity (Csharp)         |                     |                        | ?                  | [You?](https://github.com/appwrite/sdk-generator/issues/20) |

## Supported Server SDKs

| Language   | Supported Versions  |  Coding Standards      |  Package Manager   | Contributors   |

|------------|---------------------|------------------------|--------------------|----------------|

| TypeScript |                     | [NPM Coding Style]     | NPM, Yarn          | [@eldadfux]    |

| NodeJS     | 8, 10, 12           | [NPM Coding Style]     | NPM, Yarn          | [@eldadfux]    |

| PHP        | 7.0+                | [PHP FIG]              | Composer           | [@eldadfux]    |

| Ruby       | 2.4+                | [Ruby Style Guide]     | GEM                | [@eldadfux] [@abnegate] |

| Python     | 3.5+                | [PEP8]                 | PIP                | [@eldadfux] [@abnegate] |

| Dart       | 2.7+                | [Effective Dart]       | pub                | [@lohanidamodar] |

| Go         |                     | [Effective Go]         | go get             | [@panz3r] [@phaus]      |

| .NET       | .NET core 3.1       | [C# Coding Conventions]| NuGet              | [@komemi] [@TorstenDittmann]     |

| D          |                     |                        | ?                  | [You?](https://github.com/appwrite/sdk-generator/issues/20) |

| Kotlin     | 1.4.31+             | [Kotlin style guide]   | Gradle, Maven      | [@abnegate]    |

| Java       | 8+                  | [Google style guide]   | Gradle, Maven      | [@abnegate]    |

| Swift      | 5.5+                | [Swift Style Guide]    | Swift Pkg Manager  | [@abnegate]    |

| Docker CLI |                     |                        | Docker Hub         | [@christyjacob4]  |

[@Almoullim]:           https://github.com/Almoullim

[@eldadfux]:            https://github.com/eldadfux

[@panz3r]:              https://github.com/panz3r

[@armino-dev]:          https://github.com/armino-dev

[@bartektartanus]:      https://github.com/bartektartanus

[@komemi]:              https://github.com/komemi

[@TorstenDittmann]:     https://github.com/TorstenDittmann

[@lohanidamodar]:       https://github.com/lohanidamodar

[@christyjacob4]:       https://github.com/christyjacob4

[@abnegate]:            https://github.com/abnegate

[PHP FIG]:              https://www.php-fig.org/

[NPM Coding Style]:     https://docs.npmjs.com/misc/coding-style

[NPM Coding Style]:     https://docs.npmjs.com/misc/coding-style

[Ruby Style Guide]:     https://github.com/rubocop-hq/ruby-style-guide

[PEP8]:                 https://www.python.org/dev/peps/pep-0008/

[Effective Dart]:       https://dart.dev/guides/language/effective-dart/style

[Effective Go]:         https://golang.org/doc/effective_go.html

[Swift Style Guide]:    https://google.github.io/swift/

[C# Coding Conventions]:https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions

[Kotlin style guide]:   https://kotlinlang.org/docs/coding-conventions.html#apply-the-style-guide

[Android style guide]:  https://developer.android.com/kotlin/style-guide

[Google style guide]:   https://google.github.io/styleguide/javaguide.html

## 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](CONTRIBUTING.md).

## Copyright and license

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