Fork me on GitHub

Alex Rupérez

Link: http://j.mp/2t6C6Ia
Published: 04 Feb 14:54
I starred Yelp/swagger-gradle-codegen at GitHub.
💫 A Gradle Plugin to generate your networking code from Swagger
View on GitHub


View README


Swagger Gradle Codegen

Plugin Portal Build Status License Twitter

A Gradle plugin to generate networking code from a Swagger spec file.

This plugin wraps swagger-codegen, and exposes a configurable generateSwagger gradle task that you can plug inside your gradle build/workflows.

Getting Started

Swagger Gradle Codegen is distributed through Gradle Plugin Portal. To use it you need to add the following dependency to your gradle files. Please note that those code needs to be added the gradle file of the module where you want to generate the code (not the top level build.gradle[.kts] file). Please also note that the plugin uses gradle 5.+ features, and you will need to setup your gradle wrapper to use 5.0 or more.

If you're using the Groovy Gradle files:

buildscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2/" }
    }

    dependencies {
        classpath "com.yelp.codegen:plugin:<latest_version>"
    }
}

apply plugin: "com.yelp.codegen.plugin"

generateSwagger {
    platform = "kotlin"
    packageName = "com.yelp.codegen.samples"
    inputFile = file("./sample_specs.json")
    outputDir = file("./src/main/java/")
}

If you're using the Kotlin Gradle files:

plugins {
    id("com.yelp.codegen.plugin") version "<latest_version>"
}

generateSwagger {
    platform = "kotlin"
    packageName = "com.yelp.codegen.samples"
    inputFile = file("./sample_specs.json")
    outputDir = file("./src/main/java/")
}

Please note that the generateSwagger { } block is needed in order to let the plugin work.

Once you setup the plugin correctly, you can call the :generateSwagger gradle task, that will run the code generation with the configuration you provided.

Supported platforms

The Swagger Gradle Codegen is designed to support multiple platforms. For every platform, we provide templates that are tested and generates opinionated code.

Here the list of the supported platforms:

Platform Description
kotlin Generates Kotlin code and Retrofit interfaces, with RxJava2 for async calls, Moshi for serialization and ThreeTenABP for Data management

We're looking forward to more platforms to support in the future. Contributions are more than welcome.

Examples

You can find some examples in this repository to help you set up your generator environment.

  • samples/generated-code Contains an example of an Android Library where the code is generated inside the /scr/main/java folder. You can use this example to see how the generated code will look like (like here)

  • samples/groovy-android Contains an example of an Android Library configured with a build.gradle file, using the classical Gradle/Groovy as scripting language.

  • samples/kotlin-android Contains an example of an Android Library configured with a build.gradle.kts file, using Kotlin as scripting language.

How the generated code will look like

Here you can find some examples of how the generated code will look like in your project.

Configuration

To configure the generator, please use the generateSwagger { } block. Here an example of this block with all the properties.

generateSwagger {
    platform = "kotlin"
    packageName = "com.yelp.codegen.integrations"
    specName = "integration"
    specVersion = "1.0.0"
    inputFile = file("../sample_specs.json")
    outputDir = file("./src/main/java/")
    features {
        headersToRemove = ["Accept-Language"]
    }
}

And here a table with all the properties and their default values:

Property Description Default
inputFile Defines the path to the Swagger spec file REQUIRED
platform Defines the platform/templates that will be used. See Supported platforms for a list of them. "kotlin"
packageName Defines the fully qualified package name that will be used as root when generating the code. "com.codegen.default"
specName Defines the name of the service that is going to be built. "defaultname"
specVersion Defines the version of the spec that is going to be used. If not provided, the version will be read from the specfile. If version is missing will default to "0.0.0"
outputDir Defines the output root folder for the generated files. $buildDir/gen
extraFiles Defines a folder with extra files that will be copied over after the generation (e.g. util classes or overrides). not set by default

Please note that all those properties can be configured with command line flags that mirrors 1:1 the property name. E.g.:

./gradlew generateSwagger --inputFile=./sample/specs.json

Extra Features

You can use the features { } block to specify customization or enabled/disable specific features for your generator.

Here a list of all the supported features:

Feature Description Command line
headersToRemove List of headers that needs to be ignored for every endpoints. The headers in this list will be dropped and not generated as parameters for the endpoints. --featureHeaderToRemove=

Building

To contribute or to start developing the Swagger Codegen Plugin, you need to set up your environment.

Make sure you have:

  • Python (needed for pre-commit hook)
  • Java/Kotlin (needed for compiling the plugin code)

We also recommend you set up:

  • aactivator To correctly manage your venv connected to this project
  • IntelliJ IDEA Either the Community or the Ultimate edition are great to contribute to the plugin.

Before starting developing, please run:

make install-hooks

This will take care of installing the pre-commit hooks to keep a consistent style in the codebase.

While developing, you can run tests on the plugin using:

./gradlew plugin:test

Make sure your tests are all green locally before submitting PRs.

Contributing

We're looking for contributors! Feel free to open issues/pull requests to help me improve this project.

If you found a new issue related to incompatible Swagger specs, please attach also the spec file to help investigate the issue.

License 📄

This project is licensed under the Apache 2.0 License - see the License file for details