Convert Figma logo to code with AI

swagger-api logoswagger-codegen

swagger-codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing your OpenAPI / Swagger definition.

16,964
6,037
16,964
3,423
View on GitHub

Top Related Projects

OpenAPITools's avatar

openapi-generator

21,595

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)

apiaryio's avatar

api-blueprint

8,648

API Blueprint

slatedocs's avatar

slate

36,008

Beautiful static documentation for your API

stoplightio's avatar

prism

4,272

Turn any OpenAPI2/3 and Postman Collection file into an API server with mocking, transformations and validations.

Mermade's avatar

widdershins

1,479

OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown

Quick Overview

Swagger Codegen is an open-source tool that generates server stubs, client SDKs, and API documentation from OpenAPI (formerly Swagger) specifications. It supports a wide range of programming languages and frameworks, allowing developers to quickly create API-first applications and services.

Pros

  • Supports numerous programming languages and frameworks
  • Generates both client and server code from a single OpenAPI specification
  • Customizable templates for fine-tuning generated code
  • Active community and regular updates

Cons

  • Generated code may require manual refinement for production use
  • Learning curve for customizing templates and configurations
  • Some languages and frameworks have better support than others
  • Large codebase can make it challenging to contribute or debug issues

Code Examples

  1. Generating a Java client:
java -jar swagger-codegen-cli.jar generate \
  -i https://petstore.swagger.io/v2/swagger.json \
  -l java \
  -o ./java-client
  1. Generating a Python Flask server:
java -jar swagger-codegen-cli.jar generate \
  -i https://petstore.swagger.io/v2/swagger.json \
  -l python-flask \
  -o ./python-flask-server
  1. Generating TypeScript-Angular client:
java -jar swagger-codegen-cli.jar generate \
  -i https://petstore.swagger.io/v2/swagger.json \
  -l typescript-angular \
  -o ./typescript-angular-client

Getting Started

  1. Download the latest swagger-codegen-cli.jar from the GitHub releases page.
  2. Run the following command to generate code:
java -jar swagger-codegen-cli.jar generate \
  -i <path-to-your-swagger-spec> \
  -l <target-language> \
  -o <output-directory>
  1. Replace <path-to-your-swagger-spec> with the URL or file path to your OpenAPI specification, <target-language> with your desired language/framework, and <output-directory> with the desired output location.
  2. Navigate to the output directory and follow the generated README.md for further instructions on using the generated code.

Competitor Comparisons

OpenAPITools logo

openapi-generator

21,595

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)

Pros of openapi-generator

  • More active development and frequent updates
  • Supports a wider range of programming languages and frameworks
  • Better documentation and community support

Cons of openapi-generator

  • Steeper learning curve for newcomers
  • May have more breaking changes due to frequent updates

Code Comparison

swagger-codegen:

public class PetApi {
    private ApiClient apiClient;

    public PetApi() {
        this(Configuration.getDefaultApiClient());
    }
}

openapi-generator:

public class PetApi {
    private final ApiClient apiClient;

    public PetApi(ApiClient apiClient) {
        this.apiClient = apiClient;
    }
}

The main differences in the code snippets are:

  1. openapi-generator uses a final keyword for the apiClient field
  2. openapi-generator's constructor takes an ApiClient parameter
  3. swagger-codegen has a no-arg constructor that uses a default ApiClient

Both projects aim to generate client libraries, server stubs, and documentation from OpenAPI (formerly Swagger) definitions. openapi-generator is a fork of swagger-codegen that has since evolved independently. While both tools serve similar purposes, openapi-generator generally offers more features, better performance, and wider language support. However, swagger-codegen may be simpler for beginners and have fewer breaking changes between versions.

apiaryio logo

api-blueprint

8,648

API Blueprint

Pros of API Blueprint

  • Uses a simple, human-readable Markdown-based syntax
  • Focuses on design-first API development
  • Supports a wide range of tools and integrations

Cons of API Blueprint

  • Less widely adopted compared to Swagger/OpenAPI
  • Limited code generation capabilities
  • Fewer language-specific tools and libraries available

Code Comparison

API Blueprint example:

# GET /users/{id}
+ Response 200 (application/json)
    {
        "id": 1,
        "name": "John Doe"
    }

Swagger-Codegen (OpenAPI) example:

/users/{id}:
  get:
    responses:
      '200':
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                name:
                  type: string

Key Differences

  • Syntax: API Blueprint uses Markdown, while Swagger-Codegen uses YAML or JSON
  • Tooling: Swagger-Codegen offers more extensive code generation capabilities
  • Ecosystem: Swagger-Codegen has a larger community and more third-party tools
  • Learning curve: API Blueprint is generally easier to learn and read
  • Flexibility: Swagger-Codegen provides more detailed API specifications

Both tools have their strengths, with API Blueprint excelling in simplicity and readability, while Swagger-Codegen offers more comprehensive features and wider adoption in the industry.

slatedocs logo

slate

36,008

Beautiful static documentation for your API

Pros of Slate

  • Focuses on creating beautiful, customizable API documentation
  • Easier to set up and use for non-developers
  • Provides a more visually appealing out-of-the-box solution

Cons of Slate

  • Limited to documentation generation, unlike Swagger Codegen's broader capabilities
  • Less flexibility in terms of input formats and programming languages
  • May require more manual effort for complex API structures

Code Comparison

Slate (Ruby):

require 'middleman'
require 'middleman-syntax'
require 'middleman-autoprefixer'
require 'middleman-sprockets'
require 'rouge'
require 'redcarpet'

Swagger Codegen (Java):

import io.swagger.codegen.*;
import io.swagger.models.Swagger;
import io.swagger.parser.SwaggerParser;

public class CustomGenerator extends DefaultGenerator {
    // Custom generator implementation
}

Slate is primarily designed for creating API documentation, using Ruby and Markdown to generate static HTML pages. It offers a clean, three-column layout that's easy to navigate and customize.

Swagger Codegen, on the other hand, is a more comprehensive tool that generates server stubs, client SDKs, and documentation for various programming languages based on OpenAPI (Swagger) specifications. It's more versatile but may have a steeper learning curve for non-developers.

While Slate excels in producing visually appealing documentation quickly, Swagger Codegen offers broader functionality for API development and integration across multiple platforms and languages.

stoplightio logo

prism

4,272

Turn any OpenAPI2/3 and Postman Collection file into an API server with mocking, transformations and validations.

Pros of Prism

  • Lightweight and fast mock server for API development and testing
  • Supports dynamic mocking and request validation out of the box
  • Easy to set up and use with minimal configuration

Cons of Prism

  • Limited code generation capabilities compared to Swagger Codegen
  • Focused primarily on mocking and validation, not full API lifecycle management
  • Less extensive language support for client/server code generation

Code Comparison

Prism (CLI usage):

prism mock api.yaml

Swagger Codegen (CLI usage):

java -jar swagger-codegen-cli.jar generate \
  -i api.yaml \
  -l java \
  -o ./generated

Key Differences

Prism is designed for API mocking and validation, making it ideal for rapid prototyping and testing. It excels in creating mock servers quickly with minimal setup.

Swagger Codegen, on the other hand, focuses on generating client SDKs and server stubs across multiple programming languages. It offers more comprehensive code generation capabilities but requires more configuration.

While Prism provides a streamlined experience for API mocking, Swagger Codegen offers broader language support and more extensive customization options for code generation.

Choose Prism for quick API mocking and validation during development, and Swagger Codegen for generating client libraries and server stubs across various programming languages.

Mermade logo

widdershins

1,479

OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown

Pros of Widdershins

  • Supports multiple API description formats (OpenAPI, AsyncAPI, Semoasa)
  • Generates documentation in various formats (Markdown, Slate, Shins)
  • Lightweight and faster for simple documentation generation tasks

Cons of Widdershins

  • Limited to documentation generation, unlike Swagger Codegen's broader scope
  • Less extensive language support for code generation
  • Smaller community and fewer contributors compared to Swagger Codegen

Code Comparison

Widdershins (JavaScript):

const widdershins = require('widdershins');
let options = {};
widdershins.convert(apiDefinition, options)
  .then(output => console.log(output))
  .catch(err => console.error(err));

Swagger Codegen (Java):

CodegenConfig config = new JavaClientCodegen();
ClientOptInput input = new ClientOptInput().config(config);
input.setOpenAPI(parseOpenAPISpec(specFile));
DefaultGenerator generator = new DefaultGenerator();
generator.opts(input).generate();

While Widdershins focuses on documentation generation from API specifications, Swagger Codegen offers a broader range of functionality, including code generation for various programming languages and frameworks. Widdershins is more lightweight and specialized in creating documentation, while Swagger Codegen provides a comprehensive toolkit for API development and integration.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Build Status

Build Status

Build Status

Maven Central

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

:notebook_with_decorative_cover: For more information, please refer to the Wiki page and FAQ :notebook_with_decorative_cover:

: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:

:notebook_with_decorative_cover: The eBook A Beginner's Guide to Code Generation for REST APIs is a good starting point for beginners.

Versioning

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 (master branch) supports Swagger/OpenAPI version 2, while 3.X (3.0.0 branch) 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.

Swagger Codegen 2.X (master branch)

Swagger Codegen 2.X supports Swagger/OpenAPI version 2.

group id: io.swagger maven central (maven plugin): https://mvnrepository.com/artifact/io.swagger/swagger-codegen-maven-plugin

dependency example:

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-codegen-maven-plugin</artifactId>
    <version>2.4.43</version>
</dependency>

Swagger Codegen 3.X (3.0.0 branch)

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.v3 maven central: https://mvnrepository.com/artifact/io.swagger.codegen.v3

dependency example:

<dependency>
    <groupId>io.swagger.codegen.v3</groupId>
    <artifactId>swagger-codegen-maven-plugin</artifactId>
    <version>3.0.61</version>
</dependency>

Overview

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:

  • API clients: ActionScript, Ada, Apex, Bash, C# (.net 2.0, 3.5 or later), C++ (cpprest, Qt5, Tizen), Clojure, Dart, Elixir, Elm, Eiffel, Erlang, Go, Groovy, Haskell (http-client, Servant), Java (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java, Rest-assured), Kotlin, Lua, Node.js (ES5, ES6, AngularJS with Google Closure Compiler annotations) Objective-C, Perl, PHP, PowerShell, Python, R, Ruby, Rust (rust, rust-server), Scala (akka, http4s, swagger-async-httpclient), Swift (2.x, 3.x, 4.x, 5.x), Typescript (Angular1.x, Angular2.x, Fetch, jQuery, Node)
  • Server stubs: Ada, C# (ASP.NET Core, NancyFx), C++ (Pistache, Restbed), Erlang, Go, Haskell (Servant), Java (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, RestEasy, Play Framework, PKMST), Kotlin, PHP (Lumen, Slim, Silex, Symfony, Zend Expressive), Python (Flask), NodeJS, Ruby (Sinatra, Rails5), Rust (rust-server), Scala (Finch, Lagom, Scalatra)
  • API documentation generators: HTML, Confluence Wiki
  • Configuration files: Apache2
  • Others: JMeter

Check out OpenAPI-Spec for additional information about the OpenAPI project.

Table of contents

Compatibility

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 VersionRelease DateOpenAPI Spec compatibilityNotes
3.0.62-SNAPSHOT (current 3.0.0, upcoming minor release) SNAPSHOTTBD1.0, 1.1, 1.2, 2.0, 3.0Minor release
3.0.61 (current stable)2024-08-091.0, 1.1, 1.2, 2.0, 3.0tag v3.0.61
3.0.602024-08-011.0, 1.1, 1.2, 2.0, 3.0tag v3.0.60
3.0.592024-07-221.0, 1.1, 1.2, 2.0, 3.0tag v3.0.59
3.0.582024-07-081.0, 1.1, 1.2, 2.0, 3.0tag v3.0.58
3.0.572024-05-271.0, 1.1, 1.2, 2.0, 3.0tag v3.0.57
3.0.562024-05-101.0, 1.1, 1.2, 2.0, 3.0tag v3.0.56
3.0.552024-04-221.0, 1.1, 1.2, 2.0, 3.0tag v3.0.55
3.0.542024-02-191.0, 1.1, 1.2, 2.0, 3.0tag v3.0.54
3.0.532024-02-141.0, 1.1, 1.2, 2.0, 3.0tag v3.0.53
3.0.522023-12-301.0, 1.1, 1.2, 2.0, 3.0tag v3.0.52
3.0.512023-11-211.0, 1.1, 1.2, 2.0, 3.0tag v3.0.51
3.0.502023-10-261.0, 1.1, 1.2, 2.0, 3.0tag v3.0.50
3.0.492023-10-231.0, 1.1, 1.2, 2.0, 3.0tag v3.0.49
3.0.482023-10-191.0, 1.1, 1.2, 2.0, 3.0tag v3.0.48
3.0.472023-10-021.0, 1.1, 1.2, 2.0, 3.0tag v3.0.47
3.0.462023-06-071.0, 1.1, 1.2, 2.0, 3.0tag v3.0.46
3.0.452023-06-021.0, 1.1, 1.2, 2.0, 3.0tag v3.0.45
3.0.442023-05-231.0, 1.1, 1.2, 2.0, 3.0tag v3.0.44
3.0.432023-05-171.0, 1.1, 1.2, 2.0, 3.0tag v3.0.43
3.0.422023-04-051.0, 1.1, 1.2, 2.0, 3.0tag v3.0.42
3.0.412023-02-161.0, 1.1, 1.2, 2.0, 3.0tag v3.0.41
3.0.402023-01-271.0, 1.1, 1.2, 2.0, 3.0tag v3.0.40
3.0.392023-01-251.0, 1.1, 1.2, 2.0, 3.0tag v3.0.39
3.0.382023-01-221.0, 1.1, 1.2, 2.0, 3.0tag v3.0.38
3.0.372023-01-191.0, 1.1, 1.2, 2.0, 3.0tag v3.0.37
3.0.362022-11-101.0, 1.1, 1.2, 2.0, 3.0tag v3.0.36
3.0.352022-08-151.0, 1.1, 1.2, 2.0, 3.0tag v3.0.35
3.0.342022-04-121.0, 1.1, 1.2, 2.0, 3.0tag v3.0.34
3.0.332022-02-071.0, 1.1, 1.2, 2.0, 3.0tag v3.0.33
3.0.322022-01-111.0, 1.1, 1.2, 2.0, 3.0tag v3.0.32
3.0.312021-12-281.0, 1.1, 1.2, 2.0, 3.0tag v3.0.31
3.0.302021-11-181.0, 1.1, 1.2, 2.0, 3.0tag v3.0.30
3.0.292021-10-051.0, 1.1, 1.2, 2.0, 3.0tag v3.0.29
3.0.282021-09-301.0, 1.1, 1.2, 2.0, 3.0tag v3.0.28
3.0.272021-06-281.0, 1.1, 1.2, 2.0, 3.0tag v3.0.27
3.0.262021-05-281.0, 1.1, 1.2, 2.0, 3.0tag v3.0.26
3.0.252021-03-041.0, 1.1, 1.2, 2.0, 3.0tag v3.0.25
3.0.242020-12-291.0, 1.1, 1.2, 2.0, 3.0tag v3.0.24
3.0.232020-11-021.0, 1.1, 1.2, 2.0, 3.0tag v3.0.23
3.0.222020-10-051.0, 1.1, 1.2, 2.0, 3.0tag v3.0.22
3.0.212020-07-281.0, 1.1, 1.2, 2.0, 3.0tag v3.0.21
3.0.202020-05-181.0, 1.1, 1.2, 2.0, 3.0tag v3.0.20
3.0.192020-04-021.0, 1.1, 1.2, 2.0, 3.0tag v3.0.19
3.0.182020-02-261.0, 1.1, 1.2, 2.0, 3.0tag v3.0.18
3.0.172020-02-231.0, 1.1, 1.2, 2.0, 3.0tag v3.0.17
3.0.172020-01-151.0, 1.1, 1.2, 2.0, 3.0tag v3.0.16
3.0.152020-01-031.0, 1.1, 1.2, 2.0, 3.0tag v3.0.15
3.0.142019-11-161.0, 1.1, 1.2, 2.0, 3.0tag v3.0.14
3.0.132019-10-161.0, 1.1, 1.2, 2.0, 3.0tag v3.0.13
3.0.122019-10-141.0, 1.1, 1.2, 2.0, 3.0tag v3.0.12
3.0.112019-08-241.0, 1.1, 1.2, 2.0, 3.0tag v3.0.11
3.0.102019-07-111.0, 1.1, 1.2, 2.0, 3.0tag v3.0.10
3.0.92019-06-281.0, 1.1, 1.2, 2.0, 3.0tag v3.0.9
3.0.82019-04-251.0, 1.1, 1.2, 2.0, 3.0tag v3.0.8
3.0.72019-03-261.0, 1.1, 1.2, 2.0, 3.0tag v3.0.7
3.0.52019-02-181.0, 1.1, 1.2, 2.0, 3.0tag v3.0.5
3.0.42019-01-161.0, 1.1, 1.2, 2.0, 3.0tag v3.0.4
3.0.32018-11-301.0, 1.1, 1.2, 2.0, 3.0tag v3.0.3
3.0.22018-10-191.0, 1.1, 1.2, 2.0, 3.0Minor release
3.0.12018-10-051.0, 1.1, 1.2, 2.0, 3.0Major release with breaking changes
3.0.02018-09-061.0, 1.1, 1.2, 2.0, 3.0Major release with breaking changes
2.4.44-SNAPSHOT (current master, upcoming minor release) SNAPSHOTTBD1.0, 1.1, 1.2, 2.0Minor release
2.4.43 (current stable)2024-08-091.0, 1.1, 1.2, 2.0tag v2.4.42
2.4.422024-07-291.0, 1.1, 1.2, 2.0tag v2.4.42
2.4.412024-04-221.0, 1.1, 1.2, 2.0tag v2.4.41
2.4.392024-01-021.0, 1.1, 1.2, 2.0tag v2.4.39
2.4.382023-12-291.0, 1.1, 1.2, 2.0tag v2.4.38
2.4.372023-11-211.0, 1.1, 1.2, 2.0tag v2.4.37
2.4.362023-10-261.0, 1.1, 1.2, 2.0tag v2.4.36
2.4.352023-10-261.0, 1.1, 1.2, 2.0tag v2.4.35
2.4.342023-10-191.0, 1.1, 1.2, 2.0tag v2.4.34
2.4.332023-10-021.0, 1.1, 1.2, 2.0tag v2.4.33
2.4.322023-05-171.0, 1.1, 1.2, 2.0tag v2.4.32
2.4.312023-04-021.0, 1.1, 1.2, 2.0tag v2.4.31
2.4.302023-02-161.0, 1.1, 1.2, 2.0tag v2.4.30
2.4.292022-11-101.0, 1.1, 1.2, 2.0tag v2.4.29
2.4.282022-08-151.0, 1.1, 1.2, 2.0tag v2.4.28
2.4.272022-04-121.0, 1.1, 1.2, 2.0tag v2.4.27
2.4.262022-02-071.0, 1.1, 1.2, 2.0tag v2.4.26
2.4.252021-12-281.0, 1.1, 1.2, 2.0tag v2.4.25
2.4.242021-11-181.0, 1.1, 1.2, 2.0tag v2.4.24
2.4.232021-10-081.0, 1.1, 1.2, 2.0tag v2.4.23
2.4.222021-09-301.0, 1.1, 1.2, 2.0tag v2.4.22
2.4.212021-06-281.0, 1.1, 1.2, 2.0tag v2.4.21
2.4.202021-05-281.0, 1.1, 1.2, 2.0tag v2.4.20
2.4.192021-03-041.0, 1.1, 1.2, 2.0tag v2.4.19
2.4.182020-12-291.0, 1.1, 1.2, 2.0tag v2.4.18
2.4.172020-11-021.0, 1.1, 1.2, 2.0tag v2.4.17
2.4.162020-10-051.0, 1.1, 1.2, 2.0tag v2.4.16
2.4.152020-07-281.0, 1.1, 1.2, 2.0tag v2.4.15
2.4.142020-05-181.0, 1.1, 1.2, 2.0tag v2.4.14
2.4.132020-04-021.0, 1.1, 1.2, 2.0tag v2.4.13
2.4.122020-01-151.0, 1.1, 1.2, 2.0tag v2.4.12
2.4.112020-01-031.0, 1.1, 1.2, 2.0tag v2.4.11
2.4.102019-11-161.0, 1.1, 1.2, 2.0tag v2.4.10
2.4.92019-10-141.0, 1.1, 1.2, 2.0tag v2.4.9
2.4.82019-08-241.0, 1.1, 1.2, 2.0tag v2.4.8
2.4.72019-07-111.0, 1.1, 1.2, 2.0tag v2.4.7
2.4.62019-06-281.0, 1.1, 1.2, 2.0tag v2.4.6
2.4.52019-04-251.0, 1.1, 1.2, 2.0tag v2.4.5
2.4.42019-03-261.0, 1.1, 1.2, 2.0tag v2.4.4
2.4.22019-02-181.0, 1.1, 1.2, 2.0tag v2.4.2
2.4.12019-01-161.0, 1.1, 1.2, 2.0tag v2.4.1
2.4.02018-11-301.0, 1.1, 1.2, 2.0tag v2.4.0
2.3.12018-01-171.0, 1.1, 1.2, 2.0tag v2.3.1
2.3.02017-12-211.0, 1.1, 1.2, 2.0tag v2.3.0
2.2.32017-07-151.0, 1.1, 1.2, 2.0tag v2.2.3
2.2.22017-03-011.0, 1.1, 1.2, 2.0tag v2.2.2
2.2.12016-08-071.0, 1.1, 1.2, 2.0tag v2.2.1
2.1.62016-04-061.0, 1.1, 1.2, 2.0tag v2.1.6
2.0.172014-08-221.1, 1.2tag v2.0.17
1.0.42012-04-121.0, 1.1tag v1.0.4

Prerequisites

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.43/swagger-codegen-cli-2.4.43.jar -O swagger-codegen-cli.jar

java -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.61/swagger-codegen-cli-3.0.61.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.43/swagger-codegen-cli-2.4.43.jar

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 11+.

Export JAVA_HOME in order to use the supported Java version:

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

Building

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

mvn clean package

If you don't have maven installed, you may directly use the included maven wrapper, and build with the command:

./mvnw clean package

Homebrew

To install, run brew install swagger-codegen

Here is an example usage:

swagger-codegen generate -i https://petstore.swagger.io/v2/swagger.json -l ruby -o /tmp/test/

Docker

Development in docker

You can use run-in-docker.sh to do all development. This script maps your local repository to /gen in the docker container. It also maps ~/.m2/repository to 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.sh will 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

Standalone generator Development in docker

See standalone generator development

Run Docker in Vagrant

Prerequisite: install Vagrant and VirtualBox.

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

Public Pre-built Docker images

Swagger Generator Docker Image

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 jq is 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.zip will contain the generated client.

Swagger Codegen CLI Docker Image

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/go in the current directory.

Getting Started

To generate a PHP client for https://petstore.swagger.io/v2/swagger.json, please run the following

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 -c option), please run java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l php

Generators

To generate a sample client library

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

./bin/java-petstore.sh

(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 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 generate command (below only shows partial results):

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

SYNOPSIS
        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>...] [--git-repo-id <git repo id>]
                [--git-user-id <git user id>] [--group-id <group id>]
                [--http-user-agent <http user agent>]
                (-i <spec file> | --input-spec <spec file>)
                [--ignore-file-override <ignore file override location>]
                [--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-name-prefix <model name prefix>]
                [--model-name-suffix <model name suffix>]
                [--model-package <model package>]
                [(-o <output directory> | --output <output directory>)]
                [--release-note <release note>] [--remove-operation-id-prefix]
                [--reserved-words-mappings <reserved word mappings>...]
                [(-s | --skip-overwrite)]
                [(-t <template directory> | --template-dir <template directory>)]
                [--type-mappings <type mappings>...] [(-v | --verbose)]

OPTIONS
        -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

...... (results omitted)

        -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:

./bin/android-petstore.sh
./bin/java-petstore.sh
./bin/objc-petstore.sh

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 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/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

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 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 https://petstore.swagger.io/v2/swagger.json \
  -o myClient

See also standalone generator development

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 an 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
-Dmodels=User,Pet

# generate the User model and the supportingFile `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=false and -DapiDocs=false. For models, -DmodelTests=false and -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.

Ignore file format

Swagger Codegen supports a .swagger-codegen-ignore file, similar to .gitignore or .dockerignore you're probably already familiar with.

The ignore file allows for better control over overwriting existing files than the --skip-overwrite flag. 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 comments

# This 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-ignore file 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_file for greater control over generated outputs. Note that this is a complete override, and will override the .swagger-codegen-ignore file in an output directory when regenerating code.

Editor support for .swagger-codegen-ignore files is available in IntelliJ via the .ignore plugin.

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/
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.json contains the following as an example:

{
  "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 models

	apiPackage
	    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 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:

--import-mappings Pet=my.models.MyPet,Order=my.models.MyOrder

or

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

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:

http://online.swagger.io/validator/debug?url=https://petstore.swagger.io/v2/swagger.json

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

Please refer to https://github.com/swagger-api/swagger-codegen/wiki/Server-stub-generator-HOWTO for more information.

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

Maven Integration

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

Gradle Integration

Gradle Swagger Generator Plugin is available for generating source code and API document.

GitHub Integration

To push the auto-generated SDK to GitHub, we provide git_push.sh to 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

 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/petstore
  1. Push the SDK to GitHub
cd /var/tmp/perl/petstore
/bin/sh ./git_push.sh

Online generators

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:

curl -X POST -H "content-type:application/json" -d '{"swaggerUrl":"https://petstore.swagger.io/v2/swagger.json"}' https://generator.swagger.io/api/gen/clients/ruby

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

To customize the SDK, you can POST to https://generator.swagger.io/api/gen/clients/{language} with the following HTTP body:

{
  "options":  {},
  "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json"
}

in which the options for a language can be obtained by submitting a GET request to https://generator.swagger.io/api/gen/clients/{language}:

For example, curl https://generator.swagger.io/api/gen/clients/python returns

{
  "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:

{
  "options": {
    "packageName": "pet_store"
  },
  "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json"
}

and here is the curl command:

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 swaggerUrl with an URL to the OpenAPI/Swagger spec, one can include the spec in the JSON payload with spec, e.g.

{
  "options": {},
  "spec": {
    "swagger": "2.0",
    "info": {
      "version": "1.0.0",
      "title": "Test API"
    },
    ...
  }
}

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 README.md and click on the icon to edit the page.

Presentations/Videos/Tutorials/Books

Swagger Codegen Core Team

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.

Core Team Members

Template Creator

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

How to join the core team

Here are the requirements to become a core team member:

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.

Swagger Codegen Technical Committee

Members of the Swagger Codegen technical committee shoulder the following responsibilities:

  • Provides guidance and direction to other users
  • Reviews pull requests and issues
  • Improves the generator by making enhancements, fixing bugs or updating documentations
  • Sets the technical direction of the generator

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)

Members of Technical Committee

LanguagesMember (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

Security contact

Please disclose any security-related issues or vulnerabilities by emailing security@swagger.io, instead of using the public issue tracker.

License information on Generated Code

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:

  • The templates included with this project are subject to the License.
  • Generated code is intentionally not subject to the parent project license

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.

License

Copyright 2019 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 [apache.org/licenses/LICENSE-2.0](http://www.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.