hong-yew/swagger-codegen-gradle-plugin

A Gradle plugin to support the swagger code generation project

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.bubblecrisis:swagger-codegen-gradle-plugin:1.4.4'
	}
	dependencies {
		implementation("com.github.bubblecrisis:swagger-codegen-gradle-plugin:1.4.4")
	}
	<dependency>
	    <groupId>com.github.bubblecrisis</groupId>
	    <artifactId>swagger-codegen-gradle-plugin</artifactId>
	    <version>1.4.4</version>
	</dependency>

                            
    libraryDependencies += "com.github.bubblecrisis" % "swagger-codegen-gradle-plugin" % "1.4.4"
        
        

                            
    :dependencies [[com.github.bubblecrisis/swagger-codegen-gradle-plugin "1.4.4"]]

Readme

swagger-codegen-gradle-plugin

Build Status

A Gradle plugin to support the swagger code generation project

Usage

see the swagger-codegen-gradle-plugin-example, or:

Add to your build.gradle the following

ext {
    swaggerInputSpec = 'src/main/resources/petstore.yaml'
    swaggerOutput = 'src/swagger'
    swaggerLanguage = 'java'
}

apply plugin: 'org.detoeuf.swagger-code-gen'

sourceSets {
    swagger {
        java.srcDir file('src/swagger/java')
    }
}

Launch with:

gradle swagger

Configuration parameters

  • swaggerInputSpec - swagger spec file path
  • swaggerLanguage - target generation language. Adapt sourceSet accordingly.
  • swaggerTemplateDirectory - directory with mustache templates
  • swaggerApiPackage - package for default API
  • swaggerInvokerPackage - package for invoker
  • swaggerModelPackage - package for models
  • swaggerOutput - target output path (default is ${project.build.directory}/generated-sources/swagger)
  • swaggerSrc - target source directory (default is ${project.root.directory}/src/swagger). This directory should be added as as source set
  • swaggerLibrary - library template (sub-template) to use
  • swaggerSerializableModel - boolean value to set model to be serializable.