rename plug-in, generator

This commit is contained in:
wing328
2018-03-07 12:00:00 +08:00
parent 4cfbc118e8
commit f2b28d578f
35 changed files with 126 additions and 139 deletions

View File

@@ -1,7 +1,7 @@
swagger-codegen-maven-plugin
openapi-generator-maven-plugin
============================
A Maven plugin to support the [swagger](http://swagger.io) code generation project
A Maven plugin to support the OpenAPI generator project
Usage
============================
@@ -9,8 +9,8 @@ Usage
Add to your `build->plugins` section (default phase is `generate-sources` phase)
```xml
<plugin>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen-maven-plugin</artifactId>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<version>2.3.1</version>
<executions>
<execution>
@@ -49,7 +49,7 @@ mvn clean compile
- `withXml` - enable XML annotations inside the generated models and API (only works with Java `language` and libraries that provide support for JSON and XML)
- `configOptions` - a map of language-specific parameters (see below)
- `configHelp` - dumps the configuration help for the specified library (generates no sources)
- `ignoreFileOverride` - specifies the full path to a `.swagger-codegen-ignore` used for pattern based overrides of generated outputs
- `ignoreFileOverride` - specifies the full path to a `.openapi-generator-ignore` used for pattern based overrides of generated outputs
- `generateApis` - generate the apis (`true` by default)
- `generateApiTests` - generate the api tests (`true` by default. Only available if `generateApis` is `true`)
- `generateApiDocumentation` - generate the api documentation (`true` by default. Only available if `generateApis` is `true`)
@@ -67,9 +67,9 @@ Specifying a custom generator is a bit different. It doesn't support the classpa
```xml
<plugin>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen-maven-plugin</artifactId>
<version>${swagger-codegen-maven-plugin-version}</version>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<version>${openapi-generator-maven-plugin-version}</version>
<executions>
<execution>
<goals>
@@ -77,7 +77,7 @@ Specifying a custom generator is a bit different. It doesn't support the classpa
</goals>
<configuration>
<inputSpec>src/main/resources/yaml/yamlfilename.yaml</inputSpec>
<!-- language file, like e.g. JavaJaxRSCodegen shipped with swagger -->
<!-- language file, like e.g. JavaJaxRSCodegen -->
<language>com.my.package.for.GeneratorLanguage</language>
<templateDirectory>myTemplateDir</templateDirectory>

View File

@@ -1,6 +1,6 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>io.swagger</groupId>
<groupId>org.openapitools</groupId>
<artifactId>sample-project</artifactId>
<packaging>jar</packaging>
<version>1.0-SNAPSHOT</version>
@@ -10,8 +10,8 @@
<plugins>
<!-- activate the plugin -->
<plugin>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen-maven-plugin</artifactId>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<version>2.2.2-SNAPSHOT</version>
<executions>
<execution>
@@ -45,7 +45,7 @@
<!-- dependencies are needed for the client being generated -->
<dependency>
<groupId>io.swagger</groupId>
<groupId>org.openapitools</groupId>
<artifactId>swagger-annotations</artifactId>
<version>${swagger-annotations-version}</version>
</dependency>

View File

@@ -2,15 +2,15 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen-project</artifactId>
<version>2.4.0-SNAPSHOT</version>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-project</artifactId>
<version>3.0.0-SNAPSHOT</version>
<relativePath>../..</relativePath>
</parent>
<artifactId>swagger-codegen-maven-plugin</artifactId>
<name>swagger-codegen (maven-plugin)</name>
<artifactId>openapi-generator-maven-plugin</artifactId>
<name>openapi-generator (maven-plugin)</name>
<packaging>maven-plugin</packaging>
<description>maven plugin to build modules from swagger codegen</description>
<description>maven plugin to build modules from openapi generator</description>
<prerequisites>
<maven>3.2.5</maven>
</prerequisites>
@@ -45,8 +45,8 @@
<version>3.4</version>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen</artifactId>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
@@ -89,7 +89,7 @@
<groupId>net.revelc.code</groupId>
<artifactId>formatter-maven-plugin</artifactId>
<configuration>
<!-- Point at the eclipse-formatter.xml in the swagger-codegen parent project directory -->
<!-- Point at the eclipse-formatter.xml in the parent project directory -->
<configFile>${project.basedir}${file.separator}${project.parent.relativePath}${file.separator}eclipse-formatter.xml</configFile>
</configuration>
</plugin>

View File

@@ -1,4 +1,4 @@
package io.swagger.codegen.plugin;
package org.openapitools.codegen.plugin;
/*
* Copyright 2001-2005 The Apache Software Foundation.
@@ -14,18 +14,18 @@ package io.swagger.codegen.plugin;
* the License.
*/
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applyAdditionalPropertiesKvp;
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applyImportMappingsKvp;
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applyInstantiationTypesKvp;
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applyLanguageSpecificPrimitivesCsv;
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applyTypeMappingsKvp;
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applyReservedWordsMappingsKvp;
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applyAdditionalPropertiesKvpList;
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applyImportMappingsKvpList;
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applyInstantiationTypesKvpList;
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applyLanguageSpecificPrimitivesCsvList;
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applyTypeMappingsKvpList;
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applyReservedWordsMappingsKvpList;
import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyAdditionalPropertiesKvp;
import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyImportMappingsKvp;
import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyInstantiationTypesKvp;
import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyLanguageSpecificPrimitivesCsv;
import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyTypeMappingsKvp;
import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyReservedWordsMappingsKvp;
import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyAdditionalPropertiesKvpList;
import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyImportMappingsKvpList;
import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyInstantiationTypesKvpList;
import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyLanguageSpecificPrimitivesCsvList;
import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyTypeMappingsKvpList;
import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyReservedWordsMappingsKvpList;
import static org.apache.commons.lang3.StringUtils.isNotEmpty;
import java.io.File;
@@ -40,15 +40,15 @@ import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import io.swagger.codegen.CliOption;
import io.swagger.codegen.ClientOptInput;
import io.swagger.codegen.CodegenConfig;
import io.swagger.codegen.CodegenConstants;
import io.swagger.codegen.DefaultGenerator;
import io.swagger.codegen.config.CodegenConfigurator;
import org.openapitools.codegen.CliOption;
import org.openapitools.codegen.ClientOptInput;
import org.openapitools.codegen.CodegenConfig;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.DefaultGenerator;
import org.openapitools.codegen.config.CodegenConfigurator;
/**
* Goal which generates client/server code from a swagger json/yaml definition.
* Goal which generates client/server code from a OpenAPI json/yaml definition.
*/
@Mojo(name = "generate", defaultPhase = LifecyclePhase.GENERATE_SOURCES)
public class CodeGenMojo extends AbstractMojo {
@@ -65,12 +65,12 @@ public class CodeGenMojo extends AbstractMojo {
/**
* Location of the output directory.
*/
@Parameter(name = "output", property = "swagger.codegen.maven.plugin.output",
defaultValue = "${project.build.directory}/generated-sources/swagger")
@Parameter(name = "output", property = "openapi.generator.maven.plugin.output",
defaultValue = "${project.build.directory}/generated-sources/openapi")
private File output;
/**
* Location of the swagger spec, as URL or file.
* Location of the OpenAPI spec, as URL or file.
*/
@Parameter(name = "inputSpec", required = true)
private String inputSpec;
@@ -82,7 +82,7 @@ public class CodeGenMojo extends AbstractMojo {
private String gitUserId;
/**
* Git repo ID, e.g. swagger-codegen.
* Git repo ID, e.g. openapi-generator.
*/
@Parameter(name = "gitRepoId", required = false)
private String gitRepoId;

View File

@@ -2,14 +2,14 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen-project</artifactId>
<version>2.4.0-SNAPSHOT</version>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-project</artifactId>
<version>3.0.0-SNAPSHOT</version>
<relativePath>../..</relativePath>
</parent>
<artifactId>swagger-generator</artifactId>
<artifactId>openapi-generator-online</artifactId>
<packaging>war</packaging>
<name>swagger-generator</name>
<name>openapi-generator-online</name>
<build>
<sourceDirectory>src/main/java</sourceDirectory>
<resources>
@@ -136,13 +136,13 @@
<version>${swagger-core-version}</version>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen</artifactId>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator</artifactId>
<version>${project.parent.version}</version>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen</artifactId>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator</artifactId>
<version>${project.parent.version}</version>
<type>test-jar</type>
<scope>test</scope>

View File

@@ -12,7 +12,7 @@
* the License.
*/
package io.swagger.generator;
package org.openapitools.codegen.online;
import org.apache.commons.io.IOUtils;
@@ -29,11 +29,11 @@ public class Bootstrap extends HttpServlet {
public void init(ServletConfig config) throws ServletException {
DynamicSwaggerConfig bc = new DynamicSwaggerConfig();
bc.setBasePath("/api");
bc.setTitle("Swagger Generator");
bc.setDescription("This is an online swagger codegen server. You can find out more "
+ "at https://github.com/swagger-api/swagger-codegen or on [irc.freenode.net, #swagger](http://swagger.io/irc/).");
bc.setTermsOfServiceUrl("http://swagger.io/terms/");
bc.setContact("apiteam@swagger.io");
bc.setTitle("OpenAPI Generator");
bc.setDescription("This is an online OpenAPI generator. You can find out more "
+ "at https://github.com/openapi-tools/openapi-generator");
bc.setTermsOfServiceUrl("https://www.apache.org/licenses/LICENSE-2.0");
bc.setContact("openapi-generator@gmail.com");
bc.setLicense("Apache 2.0");
InputStream stream = getClass().getResourceAsStream("/version.prop");
if (stream == null) {
@@ -48,7 +48,7 @@ public class Bootstrap extends HttpServlet {
}
bc.setLicenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html");
bc.setResourcePackage("io.swagger.generator.resource");
bc.setResourcePackage("org.openapitools.codegen.online.resource");
bc.setScan(true);
}
}

View File

@@ -1,8 +1,8 @@
package io.swagger.generator;
package org.openapitools.codegen.online;
import io.swagger.codegen.Codegen;
import io.swagger.codegen.CodegenConfig;
import io.swagger.codegen.CodegenType;
import org.openapitools.codegen.Codegen;
import org.openapitools.codegen.CodegenConfig;
import org.openapitools.codegen.CodegenType;
import io.swagger.jaxrs.config.BeanConfig;
import io.swagger.models.Operation;
import io.swagger.models.Path;

View File

@@ -12,7 +12,7 @@
* the License.
*/
package io.swagger.generator.exception;
package org.openapitools.codegen.online.exception;
public class ApiException extends Exception {
private static final long serialVersionUID = -5085112752305370687L;

View File

@@ -12,7 +12,7 @@
* the License.
*/
package io.swagger.generator.exception;
package org.openapitools.codegen.online.exception;
import org.apache.http.HttpStatus;

View File

@@ -12,7 +12,7 @@
* the License.
*/
package io.swagger.generator.exception;
package org.openapitools.codegen.online.exception;
import org.apache.http.HttpStatus;

View File

@@ -1,12 +1,12 @@
package io.swagger.generator.online;
package org.openapitools.codegen.online.http;
import com.fasterxml.jackson.databind.JsonNode;
import io.swagger.codegen.*;
import io.swagger.generator.exception.ApiException;
import io.swagger.generator.exception.BadRequestException;
import io.swagger.generator.model.GeneratorInput;
import io.swagger.generator.model.InputOption;
import io.swagger.generator.util.ZipUtil;
import org.openapitools.codegen.*;
import org.openapitools.codegen.online.exception.ApiException;
import org.openapitools.codegen.online.exception.BadRequestException;
import org.openapitools.codegen.online.model.GeneratorInput;
import org.openapitools.codegen.online.model.InputOption;
import org.openapitools.codegen.online.util.ZipUtil;
import io.swagger.models.Swagger;
import io.swagger.models.auth.AuthorizationValue;
import io.swagger.parser.SwaggerParser;
@@ -86,7 +86,7 @@ public class Generator {
swagger = new SwaggerParser().read(opts.getSwaggerUrl());
}
} else {
throw new BadRequestException("No swagger specification was supplied");
throw new BadRequestException("No OpenAPI specification was supplied");
}
} else if (opts.getAuthorizationValue() != null) {
List<AuthorizationValue> authorizationValues = new ArrayList<AuthorizationValue>();
@@ -96,7 +96,7 @@ public class Generator {
swagger = new SwaggerParser().read(node, true);
}
if (swagger == null) {
throw new BadRequestException("The swagger specification supplied was not valid");
throw new BadRequestException("The OpenAPI specification supplied was not valid");
}
String destPath = null;

View File

@@ -12,7 +12,7 @@
* the License.
*/
package io.swagger.generator.model;
package org.openapitools.codegen.online.model;
import javax.xml.bind.annotation.XmlTransient;

View File

@@ -12,7 +12,7 @@
* the License.
*/
package io.swagger.generator.model;
package org.openapitools.codegen.online.model;
public class Generated {
private String filename;

View File

@@ -1,4 +1,4 @@
package io.swagger.generator.model;
package org.openapitools.codegen.online.model;
import com.fasterxml.jackson.databind.JsonNode;
import io.swagger.annotations.ApiModelProperty;

View File

@@ -12,7 +12,7 @@
* the License.
*/
package io.swagger.generator.model;
package org.openapitools.codegen.online.model;
public class InputOption {
private String name;

View File

@@ -1,4 +1,4 @@
package io.swagger.generator.model;
package org.openapitools.codegen.online.model;
import io.swagger.annotations.ApiModelProperty;

View File

@@ -1,10 +1,10 @@
package io.swagger.generator.resource;
package org.openapitools.codegen.online.resource;
import io.swagger.generator.exception.ApiException;
import io.swagger.generator.exception.BadRequestException;
import io.swagger.generator.exception.NotFoundException;
import io.swagger.generator.model.ApiResponse;
import io.swagger.generator.util.ValidationException;
import org.openapitools.codegen.online.exception.ApiException;
import org.openapitools.codegen.online.exception.BadRequestException;
import org.openapitools.codegen.online.exception.NotFoundException;
import org.openapitools.codegen.online.model.ApiResponse;
import org.openapitools.codegen.online.util.ValidationException;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;

View File

@@ -1,17 +1,17 @@
package io.swagger.generator.resource;
package org.openapitools.codegen.online.resource;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.codegen.CliOption;
import io.swagger.codegen.Codegen;
import io.swagger.codegen.CodegenConfig;
import io.swagger.codegen.CodegenType;
import io.swagger.generator.exception.BadRequestException;
import io.swagger.generator.model.Generated;
import io.swagger.generator.model.GeneratorInput;
import io.swagger.generator.model.ResponseCode;
import io.swagger.generator.online.Generator;
import org.openapitools.codegen.CliOption;
import org.openapitools.codegen.Codegen;
import org.openapitools.codegen.CodegenConfig;
import org.openapitools.codegen.CodegenType;
import org.openapitools.codegen.online.exception.BadRequestException;
import org.openapitools.codegen.online.model.Generated;
import org.openapitools.codegen.online.model.GeneratorInput;
import org.openapitools.codegen.online.model.ResponseCode;
import org.openapitools.codegen.online.http.Generator;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;

View File

@@ -12,7 +12,7 @@
* the License.
*/
package io.swagger.generator.util;
package org.openapitools.codegen.online.util;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;

View File

@@ -1,4 +1,4 @@
package io.swagger.generator.util;
package org.openapitools.codegen.online.util;
import com.fasterxml.jackson.databind.ObjectMapper;

View File

@@ -1,4 +1,4 @@
package io.swagger.generator.util;
package org.openapitools.codegen.online.util;
public class ValidationException extends Exception {
private static final long serialVersionUID = 6861195361018260380L;

View File

@@ -1,4 +1,4 @@
package io.swagger.generator.util;
package org.openapitools.codegen.online.util;
public class ValidationMessage {
private String path, message, severity;

View File

@@ -12,7 +12,7 @@
* the License.
*/
package io.swagger.generator.util;
package org.openapitools.codegen.online.util;
import java.io.BufferedInputStream;
import java.io.File;

View File

@@ -10,14 +10,14 @@
<param-name>jersey.config.server.provider.packages</param-name>
<param-value>
io.swagger.jaxrs.json,
io.swagger.generator.resource
org.openapitools.codegen.online.resource
</param-value>
</init-param>
<init-param>
<param-name>jersey.config.server.provider.classnames</param-name>
<param-value>
io.swagger.online.ExceptionWriter,
io.swagger.generator.util.JacksonJsonProvider,
org.openapitools.codegen.online.util.JacksonJsonProvider,
io.swagger.jaxrs.listing.ApiListingResource,
io.swagger.jersey.listing.JerseyApiDeclarationProvider,
io.swagger.jersey.listing.JerseyResourceListingProvider
@@ -37,11 +37,11 @@
<filter>
<filter-name>ApiOriginFilter</filter-name>
<filter-class>io.swagger.generator.util.ApiOriginFilter</filter-class>
<filter-class>org.openapitools.codegen.online.util.ApiOriginFilter</filter-class>
</filter>
<servlet>
<servlet-name>Bootstrap</servlet-name>
<servlet-class>io.swagger.generator.Bootstrap</servlet-class>
<servlet-class>org.openapitools.codegen.online.Bootstrap</servlet-class>
<init-param>
<param-name>generator.host</param-name>
<param-value>localhost:8080</param-value>

View File

@@ -1,17 +1,18 @@
package io.swagger.generator.online;
package org.openapitools.codegen.online;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.base.Function;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import io.swagger.codegen.CliOption;
import io.swagger.codegen.CodegenConfigLoader;
import io.swagger.codegen.CodegenConstants;
import io.swagger.codegen.languages.JavaClientCodegen;
import io.swagger.codegen.options.*;
import io.swagger.generator.exception.ApiException;
import io.swagger.generator.model.GeneratorInput;
import org.openapitools.codegen.CliOption;
import org.openapitools.codegen.CodegenConfigLoader;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.languages.JavaClientCodegen;
import org.openapitools.codegen.options.*;
import org.openapitools.codegen.online.exception.ApiException;
import org.openapitools.codegen.online.http.Generator;
import org.openapitools.codegen.online.model.GeneratorInput;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.testng.annotations.DataProvider;

View File

@@ -1,13 +1,14 @@
package io.swagger.generator.online;
package org.openapitools.codegen.online;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotNull;
import io.swagger.codegen.CliOption;
import io.swagger.codegen.CodegenConstants;
import io.swagger.codegen.languages.JavaClientCodegen;
import io.swagger.codegen.options.JavaOptionsProvider;
import io.swagger.generator.exception.ApiException;
import org.openapitools.codegen.CliOption;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.languages.JavaClientCodegen;
import org.openapitools.codegen.options.JavaOptionsProvider;
import org.openapitools.codegen.online.exception.ApiException;
import org.openapitools.codegen.online.http.Generator;
import org.testng.annotations.Test;

View File

@@ -1,15 +0,0 @@
package io.swagger.generator;
import io.swagger.generator.model.GeneratorInput;
import org.testng.annotations.Test;
@SuppressWarnings("static-method")
public class GeneratorInputTest {
@Test(description = "write an object")
public void writeObjectTest() {
final GeneratorInput generatorInput = new GeneratorInput();
generatorInput.setSwaggerUrl("http://petstore.swagger.io/v2/swagger.json");
}
}

View File

@@ -860,8 +860,8 @@
<modules>
<module>modules/openapi-generator</module>
<module>modules/openapi-generator-cli</module>
<!--<module>modules/swagger-codegen-maven-plugin</module>
<module>modules/swagger-generator</module>-->
<module>modules/openapi-generator-maven-plugin</module>
<module>modules/openapi-generator-online</module>
</modules>
<reporting>
<outputDirectory>target/site</outputDirectory>