swagger-codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing your OpenAPI / Swagger definition.
:star::star::star: If you would like to contribute, please refer to guidelines and a list of open tasks.:star::star::star:
:notebookwithdecorativecover: For more information, please refer to the Wiki page and FAQ :notebookwithdecorativecover:
:warning: If the OpenAPI/Swagger spec is obtained from an untrusted source, please make sure you've reviewed the spec before using Swagger Codegen to generate the API client, server stub or documentation as code injection may occur :warning:
:rocket: ProductHunt: https://producthunt.com/posts/swagger-codegen :rocket:
:notebookwithdecorative_cover: The eBook A Beginner's Guide to Code Generation for REST APIs is a good starting point for beginners.
NOTE: version 2.X (
io.swagger) and 3.X (
io.swagger.codegen.v3) have different group ids.
2.X and 3.X version lines of Swagger Codegen are available; 2.X (
masterbranch) supports Swagger/OpenAPI version 2, while 3.X (
3.0.0branch) supports OpenAPI version 3 (and version 2 via spec conversion to version 3). Online generator of version 3.X supports both generation from Swagger/OpenAPI version 2 (by using engine + generators of 2.X) and version 3 specifications.
NOTE: this document refers to version 2.X, check here for 3.X.
masterbranch)
Swagger Codegen 2.X supports Swagger/OpenAPI version 2.
group id:
io.swaggermaven central (maven plugin): https://mvnrepository.com/artifact/io.swagger/swagger-codegen-maven-plugin
dependency example:
io.swagger swagger-codegen-maven-plugin 2.4.19
3.0.0branch)
Swagger Codegen 3.X supports OpenAPI version 3 (and version 2 via spec conversion to version 3) Online generator of version 3.X supports both generation from Swagger/OpenAPI version 2 (by using engine + generators of 2.X) and version 3 specifications.
group id:
io.swagger.codegen.v3maven central: https://mvnrepository.com/artifact/io.swagger.codegen.v3
dependency example:
io.swagger.codegen.v3 swagger-codegen-maven-plugin 3.0.25
This is the Swagger Codegen project, which allows generation of API client libraries (SDK generation), server stubs and documentation automatically given an OpenAPI Spec. Currently, the following languages/frameworks are supported:
Check out OpenAPI-Spec for additional information about the OpenAPI project.
The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The Swagger Codegen project has the following compatibilities with the OpenAPI Specification:
Swagger Codegen Version |
Release Date | OpenAPI Spec compatibility | Notes |
---|---|---|---|
3.0.26-SNAPSHOT (current 3.0.0, upcoming minor release) SNAPSHOT | TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release |
3.0.25 (current stable) | 2021-03-04 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.25 |
3.0.24 | 2020-12-29 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.24 |
3.0.23 | 2020-11-02 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.23 |
3.0.22 | 2020-10-05 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.22 |
3.0.21 | 2020-07-28 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.21 |
3.0.20 | 2020-05-18 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.20 |
3.0.19 | 2020-04-02 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.19 |
3.0.18 | 2020-02-26 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.18 |
3.0.17 | 2020-02-23 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.17 |
3.0.17 | 2020-01-15 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.16 |
3.0.15 | 2020-01-03 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.15 |
3.0.14 | 2019-11-16 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.14 |
3.0.13 | 2019-10-16 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.13 |
3.0.12 | 2019-10-14 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.12 |
3.0.11 | 2019-08-24 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.11 |
3.0.10 | 2019-07-11 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.10 |
3.0.9 | 2019-06-28 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.9 |
3.0.8 | 2019-04-25 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.8 |
3.0.7 | 2019-03-26 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.7 |
3.0.5 | 2019-02-18 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.5 |
3.0.4 | 2019-01-16 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.4 |
3.0.3 | 2018-11-30 | 1.0, 1.1, 1.2, 2.0, 3.0 | tag v3.0.3 |
3.0.2 | 2018-10-19 | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release |
3.0.1 | 2018-10-05 | 1.0, 1.1, 1.2, 2.0, 3.0 | Major release with breaking changes |
3.0.0 | 2018-09-06 | 1.0, 1.1, 1.2, 2.0, 3.0 | Major release with breaking changes |
2.4.20-SNAPSHOT (current master, upcoming minor release) SNAPSHOT | TBD | 1.0, 1.1, 1.2, 2.0 | Minor release |
2.4.19 (current stable) | 2021-03-04 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.19 |
2.4.18 | 2020-12-29 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.18 |
2.4.17 | 2020-11-02 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.17 |
2.4.16 | 2020-10-05 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.16 |
2.4.15 | 2020-07-28 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.15 |
2.4.14 | 2020-05-18 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.14 |
2.4.13 | 2020-04-02 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.13 |
2.4.12 | 2020-01-15 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.12 |
2.4.11 | 2020-01-03 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.11 |
2.4.10 | 2019-11-16 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.10 |
2.4.9 | 2019-10-14 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.9 |
2.4.8 | 2019-08-24 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.8 |
2.4.7 | 2019-07-11 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.7 |
2.4.6 | 2019-06-28 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.6 |
2.4.5 | 2019-04-25 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.5 |
2.4.4 | 2019-03-26 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.4 |
2.4.2 | 2019-02-18 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.2 |
2.4.1 | 2019-01-16 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.1 |
2.4.0 | 2018-11-30 | 1.0, 1.1, 1.2, 2.0 | tag v2.4.0 |
2.3.1 | 2018-01-17 | 1.0, 1.1, 1.2, 2.0 | tag v2.3.1 |
2.3.0 | 2017-12-21 | 1.0, 1.1, 1.2, 2.0 | tag v2.3.0 |
2.2.3 | 2017-07-15 | 1.0, 1.1, 1.2, 2.0 | tag v2.2.3 |
2.2.2 | 2017-03-01 | 1.0, 1.1, 1.2, 2.0 | tag v2.2.2 |
2.2.1 | 2016-08-07 | 1.0, 1.1, 1.2, 2.0 | tag v2.2.1 |
2.1.6 | 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.org (Java 8 runtime at a minimum):
# Download current stable 2.x.x branch (Swagger and OpenAPI version 2) wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.19/swagger-codegen-cli-2.4.19.jar -O swagger-codegen-cli.jarjava -jar swagger-codegen-cli.jar help
Download current stable 3.x.x branch (OpenAPI version 3)
wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.25/swagger-codegen-cli-3.0.25.jar -O swagger-codegen-cli.jar
java -jar swagger-codegen-cli.jar --help
For Windows users, you will need to install wget or you can use Invoke-WebRequest in PowerShell (3.0+), e.g.
Invoke-WebRequest -OutFile swagger-codegen-cli.jar https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.19/swagger-codegen-cli-2.4.19.jar
On a mac, it's even easier with
brew:
sh brew install swagger-codegen
To build from source, you need the following installed and available in your
$PATH:
Don't forget to install Java 8+.
Export
JAVA_HOMEin order to use the supported Java version:
sh 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:
sh mvn clean package
If you don't have maven installed, you may directly use the included maven wrapper, and build with the command:
sh ./mvnw clean package
To install, run
brew install swagger-codegen
Here is an example usage:
sh swagger-codegen generate -i https://petstore.swagger.io/v2/swagger.json -l ruby -o /tmp/test/
You can use
run-in-docker.shto do all development. This script maps your local repository to
/genin the docker container. It also maps
~/.m2/repositoryto the appropriate container location.
To execute
mvn package:
git clone https://github.com/swagger-api/swagger-codegen cd swagger-codegen ./run-in-docker.sh mvn package
Build artifacts are now accessible in your working directory.
Once built,
run-in-docker.shwill act as an executable for swagger-codegen-cli. To generate code, you'll need to output to a directory under
/gen(e.g.
/gen/out). For example:
./run-in-docker.sh help # Executes 'help' command for swagger-codegen-cli ./run-in-docker.sh langs # Executes 'langs' command for swagger-codegen-cli ./run-in-docker.sh /gen/bin/go-petstore.sh # Builds the Go client ./run-in-docker.sh generate -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml \ -l go -o /gen/out/go-petstore -DpackageName=petstore # generates go client, outputs locally to ./out/go-petstore
See standalone generator development
Prerequisite: install Vagrant and VirtualBox.
sh git clone http://github.com/swagger-api/swagger-codegen.git cd swagger-codegen vagrant up vagrant ssh cd /vagrant ./run-in-docker.sh mvn package
The Swagger Generator image can act as a self-hosted web application and API for generating code. This container can be incorporated into a CI pipeline, and requires at least two HTTP requests and some docker orchestration to access generated code.
Example usage (note this assumes
jqis installed for command line processing of JSON):
# Start container and save the container id CID=$(docker run -d swaggerapi/swagger-generator) # allow for startup sleep 5 # Get the IP of the running container GEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}' $CID) # Execute an HTTP request and store the download link RESULT=$(curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json" }' 'http://localhost:8188/api/gen/clients/javascript' | jq '.link' | tr -d '"') # Download the generated zip and redirect to a file curl $RESULT > result.zip # Shutdown the swagger generator image docker stop $CID && docker rm $CID
In the example above,
result.zipwill contain the generated client.
The Swagger Codegen image acts as a standalone executable. It can be used as an alternative to installing via homebrew, or for developers who are unable to install Java or upgrade the installed version.
To generate code with this image, you'll need to mount a local location as a volume.
Example:
docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli generate \ -i https://petstore.swagger.io/v2/swagger.json \ -l go \ -o /local/out/go
(On Windows replace
${PWD}with
%CD%)
The generated code will be located under
./out/goin the current directory.
To generate a PHP client for https://petstore.swagger.io/v2/swagger.json, please run the following
sh git clone https://github.com/swagger-api/swagger-codegen cd swagger-codegen mvn clean package java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i https://petstore.swagger.io/v2/swagger.json \ -l php \ -o /var/tmp/php_api_client(if you're on Windows, replace the last command with
java -jar modules\swagger-codegen-cli\target\swagger-codegen-cli.jar generate -i https://petstore.swagger.io/v2/swagger.json -l php -o c:\temp\php_api_client)
You can also download the JAR (latest release) directly from maven.org
To get a list of general options available, please run
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar help generate(for version 3.x check 3.0.0 branch)
To get a list of PHP specified options (which can be passed to the generator with a config file via the
-coption), please run
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l php
You can build a client against the swagger sample petstore API as follows:
./bin/java-petstore.sh
(On Windows, run
.\bin\windows\java-petstore.batinstead)
This will run the generator with this command:
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i https://petstore.swagger.io/v2/swagger.json \ -l java \ -o samples/client/petstore/java
with a number of options. You can get the options with the
help generatecommand (below only shows partial results):
NAME swagger-codegen-cli generate - Generate code with chosen langSYNOPSIS swagger-codegen-cli generate [(-a | --auth )] [--additional-properties ...] [--api-package ] [--artifact-id ] [--artifact-version ] [(-c | --config )] [-D ...] [--git-repo-id ] [--git-user-id ] [--group-id ] [--http-user-agent ] (-i | --input-spec ) [--ignore-file-override ] [--import-mappings ...] [--instantiation-types ...] [--invoker-package ] (-l | --lang ) [--language-specific-primitives ...] [--library ] [--model-name-prefix ] [--model-name-suffix ] [--model-package ] [(-o | --output )] [--release-note ] [--remove-operation-id-prefix] [--reserved-words-mappings ...] [(-s | --skip-overwrite)] [(-t
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:
sh ./bin/android-petstore.sh ./bin/java-petstore.sh ./bin/objc-petstore.sh
It's just as easy--just use the
-iflag to point to either a server or file.
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
-tflag to specify your template folder. It actually is that easy.
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 com.my.company.codegen
This will write, in the folder
output/myLibrary, all the files you need to get started, including a `README.md. 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/myLibraryfolder with
mvn packageand 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
For Windows users, you will need to use
;instead of
:in the classpath, e.g.
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
myClientCodegenis 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 https://petstore.swagger.io/v2/swagger.json \ -o myClient
See also standalone generator development
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.
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.
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: ```sh
-Dmodels=User,Pet
StringUtil.java:
-Dmodels=User -DsupportingFiles=StringUtil.java ```
To control generation of docs and tests for api and models, pass false to the option. For api, these options are
-DapiTests=falseand
-DapiDocs=false. For models,
-DmodelTests=falseand
-DmodelDocs=false. These options default to true and don't limit the generation of the feature options listed above (like
-Dapi):
# generate only models (with tests and documentation) java -Dmodels {opts}generate only models (with tests but no documentation)
java -Dmodels -DmodelDocs=false {opts}
generate only User and Pet models (no tests and no documentation)
java -Dmodels=User,Pet -DmodelTests=false {opts}
generate only apis (without tests)
java -Dapis -DapiTests=false {opts}
generate only apis (modelTests option is ignored)
java -Dapis -DmodelTests=false {opts}
When using selective generation, only the templates needed for the specific generation will be used.
Swagger Codegen supports a
.swagger-codegen-ignorefile, similar to
.gitignoreor
.dockerignoreyou're probably already familiar with.
The ignore file allows for better control over overwriting existing files than the
--skip-overwriteflag. With the ignore file, you can specify individual files or directories can be ignored. This can be useful, for example if you only want a subset of the generated code.
Examples:
# Swagger Codegen Ignore # Lines beginning with a # are commentsThis should match build.sh located anywhere.
build.sh
Matches build.sh in the root
/build.sh
Exclude all recursively
docs/**
Explicitly allow files excluded by other rules
!docs/UserApi.md
Recursively exclude directories named Api
You can't negate files below this directory.
src/**/Api/
When this file is nested under /Api (excluded above),
this rule is ignored because parent directory is excluded by previous rule.
!src/**/PetApiTests.cs
Exclude a single, nested file explicitly
src/IO.Swagger.Test/Model/AnimalFarmTests.cs
The
.swagger-codegen-ignorefile must exist in the root of the output directory.
Upon first code generation, you may also pass the CLI option
--ignore-file-override=/path/to/ignore_filefor greater control over generated outputs. Note that this is a complete override, and will override the
.swagger-codegen-ignorefile in an output directory when regenerating code.
Editor support for
.swagger-codegen-ignorefiles is available in IntelliJ via the .ignore plugin.
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/ AbstractJavaJAXRSServerCodegen.java AbstractTypeScriptClientCodegen.java ... (results omitted) TypeScriptAngularClientCodegen.java TypeScriptNodeClientCodegen.java
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 https://petstore.swagger.io/v2/swagger.json \ -l java \ -o samples/client/petstore/java \ -c path/to/config.json
and
config.jsoncontains the following as an example:
json { "apiPackage" : "petstore" }
Supported config options can be different per language. Running
config-help -l {lang}will show available options. These options are applied via configuration file (e.g. config.json) or by passing them with
java -jar swagger-codegen-cli.jar -D{optionName}={optionValue}. (If
-D{optionName}does not work, please open a ticket and we'll look into it)
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l java
Output
CONFIG OPTIONS modelPackage package for generated modelsapiPackage package for generated api classes
...... (results omitted) library library template (sub-template) to use: jersey1 - 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 (default) - 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) google-api-client - HTTP client: google-api-client 1.23.0. JSON processing: Jackson 2.8.9 rest-assured - HTTP client: rest-assured : 3.1.0. JSON processing: Gson 2.6.1. Only for Java8
Your config file for Java can look like
{ "groupId": "com.my.company", "artifactId": "MyClient", "artifactVersion": "1.2.0", "library": "feign" }
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
ObjcClientCodegen.java:
package com.mycompany.swagger.codegen;import io.swagger.codegen.languages.*;
public class MyObjcCodegen extends ObjcClientCodegen { static { PREFIX = "HELO"; } }
and specify the
classnamewhen running the generator:
-l com.mycompany.swagger.codegen.MyObjcCodegen
Your subclass will now be loaded and overrides the
PREFIXvalue in the superclass.
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-mappingsargument and specify the model-to-import logic as such:
--import-mappings Pet=my.models.MyPet
Or for multiple mappings:
--import-mappings Pet=my.models.MyPet,Order=my.models.MyOrder
or
--import-mappings Pet=my.models.MyPet --import-mappings Order=my.models.MyOrder
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:
http://online.swagger.io/validator/debug?url=https://petstore.swagger.io/v2/swagger.json
To do so, just use the
-l dynamic-htmlflag 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.
To do so, just use the
-l htmlflag 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
Please refer to https://github.com/swagger-api/swagger-codegen/wiki/Server-stub-generator-HOWTO for more information.
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
You can use the swagger-codegen-maven-plugin for integrating with your workflow, and generating any codegen target.
Gradle Swagger Generator Plugin is available for generating source code and API document.
To push the auto-generated SDK to GitHub, we provide
git_push.shto streamline the process. For example:
1) Create a new repository in GitHub (Ref: https://help.github.com/articles/creating-a-new-repository/)
2) Generate the SDK
sh 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 "swaggerapi" \ --git-repo-id "petstore-perl" \ --release-note "Github integration demo" \ -o /var/tmp/perl/petstore3) Push the SDK to GitHub
sh cd /var/tmp/perl/petstore /bin/sh ./git_push.sh
One can also generate API client or server using the online generators (https://generator.swagger.io)
For example, to generate Ruby API client, simply send the following HTTP request using curl:
sh curl -X POST -H "content-type:application/json" -d '{"swaggerUrl":"https://petstore.swagger.io/v2/swagger.json"}' https://generator.swagger.io/api/gen/clients/rubyThen you will receive a JSON response with the URL to download the zipped code.
To customize the SDK, you can
POSTto
https://generator.swagger.io/api/gen/clients/{language}with the following HTTP body:
json { "options": {}, "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json" }in which the
optionsfor a language can be obtained by submitting a
GETrequest to
https://generator.swagger.io/api/gen/clients/{language}:
For example,
curl https://generator.swagger.io/api/gen/clients/pythonreturns
json { "packageName": { "opt": "packageName", "description": "python package name (convention: snake_case).", "type": "string", "default": "swagger_client" }, "packageVersion": { "opt": "packageVersion", "description": "python package version.", "type": "string", "default": "1.0.0" }, "sortParamsByRequiredFlag": { "opt": "sortParamsByRequiredFlag", "description": "Sort method arguments to place required parameters before optional parameters.", "type": "boolean", "default": "true" } }To set package name to
pet_store, the HTTP body of the request is as follows:
json { "options": { "packageName": "pet_store" }, "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json" }and here is the curl command:
sh curl -H "Content-type: application/json" -X POST -d '{"options": {"packageName": "pet_store"},"swaggerUrl": "https://petstore.swagger.io/v2/swagger.json"}' https://generator.swagger.io/api/gen/clients/python
Instead of using
swaggerUrlwith an URL to the OpenAPI/Swagger spec, one can include the spec in the JSON payload with
spec, e.g.
json { "options": {}, "spec": { "swagger": "2.0", "info": { "version": "1.0.0", "title": "Test API" }, ... } }
Please refer to this page
Here are some companies/projects using Swagger Codegen in production. To add your company/project to the list, please visit README.md and click on the icon to edit the page. - Acando - Accengage - Accruent - Activehours - Actonica - Acunetix - Adaptant - Atlassian - Autodesk - Avenida Compras S.A. - AYLIEN - Balance Internet - beemo - bitly - BeezUP - Box - Bufferfly Network - Cachet Financial - carpolo - Carus - Cisco - CloudBoost - Cloudsmith - Conplement - Cummins - Cupix - DBBest Technologies - DecentFoX - DocRaptor - DocuSign - Elastic - Ergon - Dell EMC - eureka - everystory.us - Expected Behavior - fashionTrade - Fastly - FINRA - Flat - Finder - Fitwell - FH Münster - University of Applied Sciences - FormAPI - Fotition - Gear Zero Network - General Electric - Genesys - PureCloud - Germin8 - GigaSpaces - GMO Pepabo - goTransverse - GraphHopper - Gravitate Solutions - HashData - Hewlett Packard Enterprise - High Technologies Center - Hootsuite - Huawei Cloud - Husbanken - IBM - IMS Health - Individual Standard IVS - INSPIDE - Intent HQ - Kabuku - Kurio - Kuroi - Kuary - Kubernetes - LANDR Audio - Lascaux - Leanix - Leica Geosystems AG - LiveAgent - LXL Tech - Lyft - MailMojo - Metaswitch - Mindera - ModuleQ - Mporium - Neverfail - NexCap - Nitrobox - Norwegian Air Shuttle - NTT DATA - nViso - Okiok - Onedata - Open International Systems - OrderCloud.io - OSDN - PagerDuty - PagerTree - Pepipost - Peatio Tech - Plexxi - Pixoneye - PostAffiliatePro - PracticeBird - Prill Tecnologia - Prokarma - QAdept - QuantiModo - QuickBlox - Rapid7 - Red Hat - Reload! A/S - REstore - REST United - Revault Sàrl - Riffyn - Royal Bank of Canada (RBC) - Saritasa - SAS - SCOOP Software GmbH - SessionM - Shine Solutions - Simpfony - Skurt - Slamby - SmartRecruiters - snapCX - SPINEN - Sponsoo - SRC - Stardog Ventures - Stingray - StyleRecipe - Svenska Spel AB - Switch Database - TaskData - ThirdWatch.ai - ThoughtWorks - Tpay - Trexle - Upwork - uShip - Variograma - VMware - Viavi Solutions Inc. - W.UP - Wealthfront - Webever GmbH - WEXO A/S - XSky - Yelp - Zalando - ZEEF.com - zooplus - Trifork
Swagger Codegen core team members are contributors who have been making significant contributions (review issues, fix bugs, make enhancements, etc) to the project on a regular basis.
Here is a list of template creators: * API Clients: * Ada: @stcarrez * Akka-Scala: @cchafer * Apex: @asnelling * Bash: @bkryza * C++ REST: @Danielku15 * C# (.NET 2.0): @who * C# (.NET Standard 1.3 ): @Gronsak * C# (.NET 4.5 refactored): @jimschubert * Clojure: @xhh * Dart: @yissachar * Dart (refactored in 2.4.0): @joernahrens * Elixir: @niku * Elm: @trenneman * Eiffel: @jvelilla * Erlang: @tsloughter * Groovy: @victorgit * Go: @wing328 * Go (rewritten in 2.3.0): @antihax * Haskell (http-client): @jonschoning * Java (Feign): @davidkiss * Java (Retrofit): @0legg * Java (Retrofit2): @emilianobonassi * Java (Jersey2): @xhh * Java (okhttp-gson): @xhh * Java (RestTemplate): @nbruno * Java (RESTEasy): @gayathrigs * Java (Vertx): @lopesmcc * Java (Google APIs Client Library): @charlescapps * Java (Rest-assured): @viclovsky * Javascript/NodeJS: @jfiala * Javascript (Closure-annotated Angular) @achew22 * JMeter: @davidkiss * Kotlin: @jimschubert * Lua: @daurnimator * Perl: @wing328 * PHP (Guzzle): @baartosz * PowerShell: @beatcracker * R: @ramnov * Rust: @farcaller * Rust (rust-server): @metaswitch * Scala (scalaz & http4s): @tbrown1979 * Swift: @tkqubo * Swift 3: @hexelon * Swift 4: @ehyche * TypeScript (Node): @mhardorf * TypeScript (Angular1): @mhardorf * TypeScript (Fetch): @leonyu * TypeScript (Angular2): @roni-frantchi * TypeScript (jQuery): @bherila * Server Stubs * Ada: @stcarrez * C# ASP.NET5: @jimschubert * C# NancyFX: @mstefaniuk * C++ Pistache: @sebymiano * C++ Restbed: @stkrwork * Erlang Server: @galaxie * Go Server: @guohuang * Haskell Servant: @algas * Java MSF4J: @sanjeewa-malalgoda * Java Spring Boot: @diyfr * Java Undertow: @stevehu * Java Play Framework: @JFCote * Java PKMST: @anshu2185 @sanshuman @rkumar-pk @ninodpillai * JAX-RS RestEasy: @chameleon82 * JAX-RS CXF: @hiveship * JAX-RS CXF (CDI): @nickcmaynard * JAX-RS RestEasy (JBoss EAP): @jfiala * Kotlin: @jimschubert * PHP Lumen: @abcsun * PHP Slim: @jfastnacht * PHP Symfony: @ksm2 * PHP Zend Expressive (with Path Handler): @Articus * Ruby on Rails 5: @zlx * Rust (rust-server): @metaswitch * Scala Finch: @jimschubert * Scala Lagom: @gmkumar2005 * Documentation * HTML Doc 2: @jhitchcock * Confluence Wiki: @jhitchcock * Configuration * Apache2: @stkrwork
Here are the requirements to become a core team member: - rank within top 50 in https://github.com/swagger-api/swagger-codegen/graphs/contributors - to contribute, here are some good starting points - regular contributions to the project - about 3 hours per week - for contribution, it can be addressing issues, reviewing PRs submitted by others, submitting PR to fix bugs or make enhancements, etc
To become a Template Creator, simply submit a PR for new API client (e.g. Rust, Elixir) or server stub (e.g. Ruby Grape) generator.
Members of the Swagger Codegen technical committee shoulder the following responsibilities:
Who is eligible? Those who want to join must have at least 3 PRs merged into a generator. (Exceptions can be granted to template creators or contributors who have made a lot of code changes with less than 3 merged PRs)
| Languages | Member (join date) | |:-------------|:-------------| | ActionScript | | | Ada | @stcarrez (2018/02) | | Android | | | Apex | | | Bash | @kenjones-cisco (2017/09) | | C++ | | | C# | @mandrean (2017/08) | | Clojure | | | Dart | @ircecho (2017/07) | | Eiffel | | | Elixir | | | Elm | | | Erlang | | | Groovy | | | Go | | | Haskell | | | Java | | | Kotlin | | | Lua | | | NodeJS/Javascript | @CodeNinjai (2017/07) | | ObjC | | | Perl | | | PHP | @dkarlovi (2017/07) @mandrean (2017/08) | | Python | @kenjones-cisco (2017/11)| | R | | | Ruby | @zlx (2017/09) | | Rust | | | Scala | | | Swift | @ehyche (2017/08) | | TypeScript | |
Please disclose any security-related issues or vulnerabilities by emailing [email protected], instead of using the public issue tracker.
The Swagger Codegen project is intended as a benefit for users of the Swagger / Open API Specification. The project itself has the License as specified. In addition, please understand the following points:
When code is generated from this project, it shall be considered AS IS and owned by the user of the software. There are no warranties--expressed or implied--for generated code. You can do what you wish with it, and once generated, the code is your responsibility and subject to the licensing terms that you deem appropriate.
Copyright 2019 SmartBear SoftwareLicensed 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 apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.