Skip to content

How to add a generator for a new language or framework

David Biesack edited this page Jan 26, 2017 · 5 revisions

Where to start?

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:

If you need any assistance, please open a ticket

Checklist (a list of items we look for in the new generator):

  • 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 kebab-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