Public | Automated Build

Last pushed: 6 months ago
Short Description
build swagger-codegen from offical github repo
Full Description

Swagger Code Generator

:star::star::star: If you would like to contribute, please refer to guidelines and a list of open tasks.:star::star::star:


This is the swagger codegen project, which allows generation of client libraries automatically from a Swagger-compliant server.

Check out Swagger-Spec for additional information about the Swagger project, including additional libraries with support for other languages and more.

Table of contents


The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The swagger-codegen project has the following compatibilies with the OpenAPI Specification:

Swagger Codegen Version Release Date OpenAPI Spec compatibility Notes
2.1.7-SNAPSHOT 1.0, 1.1, 1.2, 2.0 master
2.1.6 (current stable) 2016-04-06 1.0, 1.1, 1.2, 2.0 tag v2.1.6
2.0.17 2014-08-22 1.1, 1.2 tag v2.0.17
1.0.4 2012-04-12 1.0, 1.1 tag v1.0.4


If you're looking for the latest stable version, you can grab it directly from maven central (you'll need java 7 runtime at a minimum):

wget -O swagger-codegen-cli.jar

java -jar swagger-codegen-cli.jar help

On a mac, it's even easier with brew:

brew install swagger-codegen

To build from source, you need the following installed and available in your $PATH:

OS X Users

Don't forget to install Java 7 or 8. You probably have 1.6.

Export JAVA_HOME in order to use the supported Java version:

export JAVA_HOME=`/usr/libexec/java_home -v 1.8`
export PATH=${JAVA_HOME}/bin:$PATH


After cloning the project, you can build it from source with this command:

mvn package


Build and run using docker

git clone
cd swagger-codegen
./ mvn package

Run Docker in Vagrant

Prerequisite: install Vagrant and VirtualBox.

git clone
cd swagger-codegen
vagrant up
vagrant ssh
cd /vagrant
./ mvn package

Public Docker image


To install, run brew install swagger-codegen

Here is an example usage:

swagger-codegen generate -i -l ruby -o /tmp/test/

To generate a sample client library

You can build a client against the swagger sample petstore API as follows:


(On Windows, run ./bin/windows/java-petstore.bat instead)

This will run the generator with this command:

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l java \
  -o samples/client/petstore/java

with a number of options. You can get the options with the help generate command:

        swagger-codegen-cli generate - Generate code with chosen lang

        swagger-codegen-cli generate
                [(-a <authorization> | --auth <authorization>)]
                [--additional-properties <additional properties>]
                [--api-package <api package>] [--artifact-id <artifact id>]
                [--artifact-version <artifact version>]
                [(-c <configuration file> | --config <configuration file>)]
                [-D <system properties>] [--group-id <group id>]
                (-i <spec file> | --input-spec <spec file>)
                [--import-mappings <import mappings>]
                [--instantiation-types <instantiation types>]
                [--invoker-package <invoker package>]
                (-l <language> | --lang <language>)
                [--language-specific-primitives <language specific primitives>]
                [--library <library>] [--model-package <model package>]
                [(-o <output directory> | --output <output directory>)]
                [(-s | --skip-overwrite)]
                [(-t <template directory> | --template-dir <template directory>)]
                [--type-mappings <type mappings>] [(-v | --verbose)]

        -a <authorization>, --auth <authorization>
            adds authorization headers when fetching the swagger definitions
            remotely. Pass in a URL-encoded string of name:header with a comma
            separating multiple values

        --additional-properties <additional properties>
            sets additional properties that can be referenced by the mustache
            templates in the format of name=value,name=value

        --api-package <api package>
            package for generated api classes

        --artifact-id <artifact id>
            artifactId in generated pom.xml

        --artifact-version <artifact version>
            artifact version in generated pom.xml

        -c <configuration file>, --config <configuration file>
            Path to json configuration file. File content should be in a json
            format {"optionKey":"optionValue", "optionKey1":"optionValue1"...}
            Supported options can be different for each language. Run
            config-help -l {lang} command for language specific config options.

        -D <system properties>
            sets specified system properties in the format of

        --group-id <group id>
            groupId in generated pom.xml

        -i <spec file>, --input-spec <spec file>
            location of the swagger spec, as URL or file (required)

        --import-mappings <import mappings>
            specifies mappings between a given class and the import that should
            be used for that class in the format of type=import,type=import

        --instantiation-types <instantiation types>
            sets instantiation type mappings in the format of
            type=instantiatedType,type=instantiatedType.For example (in Java):
            array=ArrayList,map=HashMap. In other words array types will get
            instantiated as ArrayList in generated code.

        --invoker-package <invoker package>
            root package for generated code

        -l <language>, --lang <language>
            client language to generate (maybe class name in classpath,

        --language-specific-primitives <language specific primitives>
            specifies additional language specific primitive types in the format
            of type1,type2,type3,type3. For example:

        --library <library>
            library template (sub-template)

        --model-package <model package>
            package for generated models

        -o <output directory>, --output <output directory>
            where to write the generated files (current dir by default)

        -s, --skip-overwrite
            specifies if the existing files should be overwritten during the

        -t <template directory>, --template-dir <template directory>
            folder containing the template files

        --type-mappings <type mappings>
            sets mappings between swagger spec types and generated code types in
            the format of swaggerType=generatedType,swaggerType=generatedType.
            For example: array=List,map=Map,string=String

        -v, --verbose
            verbose mode

You can then compile and run the client, as well as unit tests against it:

cd samples/client/petstore/java
mvn package

Other languages have petstore samples, too:


Generating libraries from your server

It's just as easy--just use the -i flag to point to either a server or file.

Modifying the client library format

Don't like the default swagger client syntax? Want a different language supported? No problem! Swagger codegen processes mustache templates with the jmustache engine. You can modify our templates or make your own.

You can look at modules/swagger-codegen/src/main/resources/${your-language} for examples. To make your own templates, create your own files and use the -t flag to specify your template folder. It actually is that easy.

Making your own codegen modules

If you're starting a project with a new language and don't see what you need, swagger-codegen can help you create a project to generate your own libraries:

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar meta \
  -o output/myLibrary -n myClientCodegen -p

This will write, in the folder output/myLibrary, all the files you need to get started, including a Once modified and compiled, you can load your library with the codegen and generate clients with your own, custom-rolled logic.

You would then compile your library in the output/myLibrary folder with mvn package and execute the codegen like such:

java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar:modules/swagger-codegen-cli/target/swagger-codegen-cli.jar io.swagger.codegen.SwaggerCodegen

Note the myClientCodegen is an option now, and you can use the usual arguments for generating your library:

java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar:modules/swagger-codegen-cli/target/swagger-codegen-cli.jar \
  io.swagger.codegen.SwaggerCodegen generate -l myClientCodegen\
  -i \
  -o myClient

Where is Javascript???

See our javascript library--it's completely dynamic and doesn't require
static code generation.
There is a third-party component called swagger-js-codegen that can generate angularjs or nodejs source code from a OpenAPI Specification.

:exclamation: On Dec 7th 2015, a Javascript API client generator has been added by @jfiala.

Generating a client from local files

If you don't want to call your server, you can save the OpenAPI Spec files into a directory and pass an argument
to the code generator like this:

-i ./modules/swagger-codegen/src/test/resources/2_0/petstore.json

Great for creating libraries on your ci server, from the Swagger Editor... or while coding on an airplane.

Selective generation

You may not want to generate all models in your project. Likewise you may want just one or two apis to be written. If that's the case, you can use system properties to control the output:

The default is generate everything supported by the specific library. Once you enable a feature, it will restrict the contents generated:

# generate only models
java -Dmodels {opts}

# generate only apis
java -Dapis {opts}

# generate only supporting files
java -DsupportingFiles

# generate models and supporting files
java -Dmodels -DsupportingFiles

To control the specific files being generated, you can pass a CSV list of what you want:

# generate the User and Pet models only

# generate the User model and the supportingFile ``:

When using selective generation, only the templates needed for the specific generation will be used.

Customizing the generator

There are different aspects of customizing the code generator beyond just creating or modifying templates. Each language has a supporting configuration file to handle different type mappings, etc:

$ ls -1 modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/

Each of these files creates reasonable defaults so you can get running quickly. But if you want to configure package names, prefixes, model folders, etc. you can use a json config file to pass the values.

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l java \
  -o samples/client/petstore/java \
  -c path/to/config.json

Supported config options can be different per language. Running config-help -l {lang} will show available options. These options are applied
by passing them with `-D{optionName}={optionValue}

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l java


        package for generated models

        package for generated api classes

        Sort method arguments to place required parameters before optional parameters. Default: true

        root package for generated code

        groupId in generated pom.xml

        artifactId in generated pom.xml

        artifact version in generated pom.xml

        source folder for generated code

        prefix for generated code members and local variables

        boolean - toggle "implements Serializable" for generated models

        library template (sub-template) to use:
        <default> - HTTP client: Jersey client 1.18. JSON processing: Jackson 2.4.2
        jersey2 - HTTP client: Jersey client 2.6
        feign - HTTP client: Netflix Feign 8.1.1.  JSON processing: Jackson 2.6.3
        okhttp-gson - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1
        retrofit - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1 (Retrofit 1.9.0)
        retrofit2 - HTTP client: OkHttp 2.5.0. JSON processing: Gson 2.4 (Retrofit 2.0.0-beta2)

Your config file for Java can look like


For all the unspecified options default values will be used.

Another way to override default options is to extend the config class for the specific language.
To change, for example, the prefix for the Objective-C generated files, simply subclass the

package com.mycompany.swagger.codegen;

import io.swagger.codegen.languages.*;

public class MyObjcCodegen extends ObjcClientCodegen {
    static {
        PREFIX = "HELO";

and specify the classname when running the generator:

-l com.mycompany.swagger.codegen.MyObjcCodegen

Your subclass will now be loaded and overrides the PREFIX value in the superclass.

Bringing your own models

Sometimes you don't want a model generated. In this case, you can simply specify an import mapping to tell
the codegen what not to create. When doing this, every location that references a specific model will
refer back to your classes. Note, this may not apply to all languages...

To specify an import mapping, use the --import-mappings argument and specify the model-to-import logic as such:

--import-mappings Pet=my.models.MyPet

Or for multiple mappings:


Validating your OpenAPI Spec

You have options. The easiest is to use our online validator which not only will let you validate your spec, but with the debug flag, you can see what's wrong with your spec. For example:

Generating dynamic html api documentation

To do so, just use the -l dynamic-html flag when reading a spec file. This creates HTML documentation that is available as a single-page application with AJAX. To view the documentation:

cd samples/dynamic-html/
npm install
node .

Which launches a node.js server so the AJAX calls have a place to go.

Generating static html api documentation

To do so, just use the -l html flag when reading a spec file. This creates a single, simple HTML file with embedded css so you can ship it as an email attachment, or load it from your filesystem:

cd samples/html/
open index.html

To build a server stub

You can also use the codegen to generate a server for a couple different frameworks. Take a look here:


java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l nodejs \
  -o samples/server/petstore/nodejs

PHP Slim

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l slim \
  -o samples/server/petstore/slim

PHP Silex

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l silex \
  -o samples/server/petstore/silex

Python Flask (Connexion)

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l python-flask \
  -o samples/server/petstore/flaskConnexion

Ruby Sinatra

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l sinatra \
  -o samples/server/petstore/sinatra

Scala Scalatra

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l scalatra \
  -o samples/server/petstore/scalatra

Java JAX-RS (Jersey v1.18)

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l jaxrs \
  -o samples/server/petstore/jaxrs-jersey

Java JAX-RS (Apache CXF 2 / 3)

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l jaxrs-cxf \
  -o samples/server/petstore/jaxrs-cxf

This Codegen only generate a minimalist server stub. You must add the CXF dependency to your classpath (eg: with Maven)
If you are using CXF v2.x, you must provided a custom ResourceComparator class. This class will help CXF to choose the good resource interface for mapping an incomming request. The default behavior of CXF v2.x is not correct when many resources interface have the same global path.
See: See

You can found this class here:
TODO: This class could be directly generated by the Codegen.

You must register this class into your JAX-RS configuration file:

               <bean class="your.package.CXFInterfaceComparator"/>

This is no longer necessary if you are using CXF >=v3.x

Java JAX-RS (Resteasy)

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l jaxrs-resteasy \
  -o samples/server/petstore/jaxrs-resteasy

Java Spring MVC

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l spring-mvc \
  -o samples/server/petstore/spring-mvc

Haskell Servant

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l haskell-servant \
  -o samples/server/petstore/haskell-servant


java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i \
  -l aspnet5 \
  -o samples/server/petstore/aspnet5

To build the codegen library

This will create the swagger-codegen library from source.

mvn package

Note! The templates are included in the library generated. If you want to modify the templates, you'll need to either repackage the library OR specify a path to your scripts

Workflow integration

You can use the swagger-codegen-maven-plugin for integrating with your workflow, and generating any codegen target.

GitHub Integration

To push the auto-generated SDK to GitHub, we provide to streamline the process. For example:

1) Create a new repository in GitHub (Ref:

2) Generate the SDK

 java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
 -i modules/swagger-codegen/src/test/resources/2_0/petstore.json -l perl \
 --git-user-id "wing328" \
 --git-repo-id "petstore-perl" \
 --release-note "Github integration demo" \
 -o /var/tmp/perl/petstore

3) Push the SDK to GitHub

cd /var/tmp/perl/petstore
/bin/sh ./

Online generators

One can also generate API client or server using the online generators (

For example, to generate Ruby API client, simply send the following HTTP request using curl:

curl -X POST -H "content-type:application/json" -d '{"swaggerUrl":""}'

Then you will receieve a JSON response with the URL to download the zipped code.

Guidelines for Contribution

Please refer to this page

Companies/Projects using Swagger Codegen

Here are some companies/projects using Swagger Codegen in production. To add your company/project to the list, please visit and click on the icon to edit the page.


Copyright 2016 SmartBear Software

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

<img src=""/>

Docker Pull Command
Source Repository