-
Notifications
You must be signed in to change notification settings - Fork 173
/
README.md
143 lines (107 loc) · 7.36 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# ⚙️ Appwrite SDK Generator
[](https://appwrite.io/discord)
[](https://travis-ci.com/appwrite/sdk-generator)
[](https://twitter.com/appwrite)
[](https://stackshare.io/appwrite)
[](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
<?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](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