Generating Code
API Hub for Design lets you generate server and client code based on API definitions to help you get your API servers and clients up and running quickly. You can also configure integrations to automatically push the generated code to a repository on GitHub, GitLab, Bitbucket, or Azure DevOps.
Code generation is supported for both OpenAPI 2.0 and 3.0.
Learn more
Supported languages and frameworks
The following table lists the available code generators for OpenAPI 2.0 and 3.0 definitions. Note that API editors can choose which generators will actually appear in the Export menu.
Notes:
OpenAPI 3.0 generators are currently limited, but new generators are added regularly.
Each generator has various options, such as the dependencies to use. These options can be configured by the API editors in the codegen options for individual APIs, and will apply to all users who generate code for an API. If you want to change some options but do not have Edit permissions for an API, you can fork this API and configure the codegen options for yourself.
Name | OpenAPI 2.0 | OpenAPI 3.0 | Comments |
|---|---|---|---|
Servers | |||
C# / ASP.NET Core ( | ✓ | ✓ | |
C# / NancyFx ( | ✓ | ||
C++ / Pistache ( | ✓ |
| |
C++ / Restbed ( | ✓ |
| |
Erlang ( | ✓ | ||
Go ( | ✓ | ✓ |
|
Haskell / Servant ( | ✓ | ||
Java / Apache CXF ( | ✓ | ✓ | |
Java / Apache CXF and CDI ( | ✓ | ||
Java / JAX-RS using Jersey | ✓ | ✓ | |
Java / JAX-RS ( | ✓ | ✓ | Uses standard JAX-RS APIs, does not depend on specific JAX-RS implementations. |
Java / MSF4J ( | ✓ | ||
Java / PKMST ( | ✓ | Uses ProKarma microservices toolkit. | |
Java / RESTEasy ( | ✓ | ✓ | |
Java / RESTEasy with JBoss EAP ( | ✓ | ||
Java / Spring ( | ✓ | ✓ | Can be Spring Boot with Springfox, Spring MVC with Springfox, or Spring Cloud Feign, depending on the codegen options. |
Java / Swagger Inflector ( | ✓ | ✓ | |
Java / Undertow ( | ✓ | ||
Node.js ( | ✓ | ✓ | |
PHP / Lumen ( | ✓ | ||
PHP / Silex ( | ✓ | ||
PHP / Slim ( | ✓ | ||
PHP / Symfony ( | ✓ | ||
Python / Flask ( | ✓ | ✓ | |
Ruby on Rails 5 ( | ✓ | ||
Ruby / Sinatra ( | ✓ | ||
Rust ( | ✓ |
| |
Scala / Akka HTTP ( | ✓ | ||
Scala / Scalatra ( | ✓ | ||
Clients | |||
ActionScript ( | ✓ | ||
Android / Java ( | ✓ | ||
Apex ( | ✓ | ||
C++ using C++ REST SDK ( | ✓ | ||
C++ / Qt 5 ( | ✓ | ||
C++ / Tizen ( | ✓ | ||
C# / .NET 3.5 or later ( | ✓ | ✓ | The target .NET framework version can be changed in the codegen options. |
C# / .NET 2.0 using Mono compiler ( | ✓ | ||
Clojure ( | ✓ | ||
Dart ( | ✓ | ||
Go ( | ✓ | ✓ | |
Groovy ( | ✓ | ||
Java ( | ✓ | ✓ | Uses one of the following HTTP client libraries: Jersey (default), Google API Client Library for Java, OkHttp, OpenFeign, RESTEasy, Spring RestTemplate, Vert.x. |
Java / JAX-RS Client API with Apache CXF ( | ✓ | ✓ | |
JavaScript ( | ✓ | ||
JavaScript / AngularJS ( | ✓ | AngularJS (Angular 1.x) with Google Closure Compiler annotations. | |
JMeter ( | ✓ | ||
Kotlin ( | ✓ | ✓ | |
Objective-C ( | ✓ | ||
Perl ( | ✓ | ||
PHP ( | ✓ | ✓ | |
Python ( | ✓ | ✓ | |
Ruby ( | ✓ | ||
Scala ( | ✓ | ✓ | |
Scala / Akka ( | ✓ | ||
Swift 2.x ( | ✓ | ||
Swift 3.x ( | ✓ | ✓ | |
Swift 4.x ( | ✓ | ✓ | |
Swift 5.x ( | ✓ | ✓ |
|
TypeScript / Angular ( | ✓ | ✓ | Angular version is 4.3.0 by default, but can be changed in the codegen options. |
TypeScript / AngularJS ( | ✓ | Angular 1.x. | |
TypeScript / Fetch ( | ✓ | ✓ | |
TypeScript / Inversify ( | ✓ | ||
TypeScript / Node.js ( | ✓ | ||
Documentation | |||
| ✓ | Confluence wiki markup. | |
| ✓ | ✓ | Multiple HTML pages with left-side navigation. |
| ✓ | ✓ | A single print-friendly HTML page. |
| ✓ | ✓ | A single HTML page with left-side navigation and tabbed code examples. |
Swagger Codegen versions
Code generation is powered by the open-source Swagger Codegen project. The following table lists the Codegen versions used. You can also find the currently used Codegen version in the .swagger-codegen\VERSION file in the generated code.
API Hub for Design version | Codegen version for... | |
|---|---|---|
OpenAPI 2.0 | OpenAPI 3.0 | |
API Hub for Design SaaS | 2.4.26 | 3.0.33 |