-
Notifications
You must be signed in to change notification settings - Fork 6k
How to add a generator for a new language or framework
wing328 edited this page Dec 28, 2016
·
5 revisions
To add an API client generator for a new language (e.g. Go), we would recommend going through the following PR as a starting point:
To add a server stub generator for a new framework (e.g. Haskell Servant), please go through the following PRs:
- Code generator for haskell-servant framework #2009
- [aspnet] Initial implementation of ASP.NET 5 server #2024
If you need any assistance, please open a ticket
- Tests Cases
- Shell script under ./bin/ to generate Petstore sample
- Windows batch file under .\bin\windows\ to generate Petstore sample
- Unit testing for Petstore sample (e.g. unit tests for PHP Petstore SDk)
- A simple test script/app to test Petstore (e.g. test.php) to serve as a starting point for developers to easily play with the auto-generated SDK
- Documentation
- Auto-generated README.md to explain the usage of the SDK
- DocString for methods and models
For new generator naming, we prefer snake_case, e.g. swift3
instead of Swift3
, erlang-server
instead of ErlangServer
.
This is not to say all the above is a must in order for the new generator to be added. If you need help implementing the above, please open a ticket and we'll help on that
would suggest when compiling to use flag to ignore tests. The tests requires extra dependencies and the compilation might fail due to that.