Skip to content

Commit

Permalink
Improvements to online codegen (#55)
Browse files Browse the repository at this point in the history
* Change openapi-online context path

* Fix openAPI generated spec of openapi-online
  • Loading branch information
cbornet authored and wing328 committed May 16, 2018
1 parent 6b80798 commit e3814f5
Show file tree
Hide file tree
Showing 10 changed files with 30 additions and 23 deletions.
4 changes: 2 additions & 2 deletions modules/openapi-generator-online/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
FROM openjdk:8-jre-alpine

WORKDIR /generator

COPY target/openapi-generator-online-3.0.0-SNAPSHOT.jar /generator/openapi-generator-online.jar
COPY target/*.jar /generator/openapi-generator-online.jar

ENV GENERATOR_HOST=http://localhost

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@
public class OpenAPI2SpringBoot implements CommandLineRunner {

@Override
public void run(String... arg0) throws Exception {
public void run(String... arg0) {
if (arg0.length > 0 && arg0[0].equals("exitcode")) {
throw new ExitException();
}
}

public static void main(String[] args) throws Exception {
public static void main(String[] args) {
new SpringApplication(OpenAPI2SpringBoot.class).run(args);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.multipart.MultipartFile;

import javax.validation.Valid;
import java.util.List;
Expand All @@ -51,9 +52,9 @@ default ResponseEntity<List<String>> clientOptions() {
}


@ApiOperation(value = "Downloads a pre-generated file", nickname = "downloadFile", notes = "A valid `fileId` is generated by the `/clients/{language}` or `/servers/{language}` POST operations. The fileId code can be used just once, after which a new `fileId` will need to be requested.", response = String.class, tags={ "clients","servers", })
@ApiOperation(value = "Downloads a pre-generated file", nickname = "downloadFile", notes = "A valid `fileId` is generated by the `/clients/{language}` or `/servers/{language}` POST operations. The fileId code can be used just once, after which a new `fileId` will need to be requested.", response = MultipartFile.class, tags={ "clients","servers", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = String.class) })
@ApiResponse(code = 200, message = "successful operation", response = MultipartFile.class) })
@RequestMapping(value = "/gen/download/{fileId}",
produces = { "application/octet-stream" },
method = RequestMethod.GET)
Expand Down Expand Up @@ -82,9 +83,9 @@ default ResponseEntity<ResponseCode> generateServerForLanguage(@ApiParam(value =
}


@ApiOperation(value = "Returns options for a client library", nickname = "getClientOptions", notes = "", response = CliOption.class, responseContainer = "Map", tags={ "clients", })
@ApiOperation(value = "Returns options for a client library", nickname = "getClientOptions", notes = "", tags={ "clients", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = CliOption.class, responseContainer = "Map") })
@ApiResponse(code = 200, message = "successful operation") })
@RequestMapping(value = "/gen/clients/{language}",
produces = { "application/json" },
method = RequestMethod.GET)
Expand All @@ -93,9 +94,9 @@ default ResponseEntity<Map<String, CliOption>> getClientOptions(@ApiParam(value
}


@ApiOperation(value = "Returns options for a server framework", nickname = "getServerOptions", notes = "", response = CliOption.class, responseContainer = "Map", tags={ "servers", })
@ApiOperation(value = "Returns options for a server framework", nickname = "getServerOptions", notes = "", tags={ "servers", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = CliOption.class, responseContainer = "Map") })
@ApiResponse(code = 200, message = "successful operation") })
@RequestMapping(value = "/gen/servers/{framework}",
produces = { "application/json" },
method = RequestMethod.GET)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("/api")
public class GenApiController implements GenApi {

private final GenApiDelegate delegate;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
public class HomeController {
@RequestMapping(value = "/")
public String index() {
System.out.println("swagger-ui.html");
return "redirect:swagger-ui.html";
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@

package org.openapitools.codegen.online.configuration;

import com.fasterxml.jackson.databind.JsonNode;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import org.springframework.core.io.Resource;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
Expand All @@ -28,6 +29,8 @@
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.io.InputStream;


@Configuration
@EnableSwagger2
Expand All @@ -51,8 +54,12 @@ public Docket customImplementation(){
.select()
.apis(RequestHandlerSelectors.basePackage("org.openapitools.codegen.online.api"))
.build()
.forCodeGeneration(true)
.directModelSubstitute(java.time.LocalDate.class, java.sql.Date.class)
.directModelSubstitute(java.time.OffsetDateTime.class, java.util.Date.class)
.directModelSubstitute(JsonNode.class, java.lang.Object.class)
.ignoredParameterTypes(Resource.class)
.ignoredParameterTypes(InputStream.class)
.apiInfo(apiInfo());
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ public void setAuthorizationValue(AuthorizationValue authorizationValue) {
this.authorizationValue = authorizationValue;
}

@ApiModelProperty(dataType = "Object")
public JsonNode getSpec() {
return spec;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,17 @@
import java.util.Map;

public class Generator {
static Logger LOGGER = LoggerFactory.getLogger(Generator.class);
private static Logger LOGGER = LoggerFactory.getLogger(Generator.class);

public static Map<String, CliOption> getOptions(String language) {
CodegenConfig config = null;
CodegenConfig config;
try {
config = CodegenConfigLoader.forName(language);
} catch (Exception e) {
throw new ResponseStatusException(HttpStatus.BAD_REQUEST, String.format("Unsupported target %s supplied. %s",
language, e));
}
Map<String, CliOption> map = new LinkedHashMap<String, CliOption>();
Map<String, CliOption> map = new LinkedHashMap<>();
for (CliOption option : config.cliOptions()) {
map.put(option.getOpt(), option);
}
Expand Down Expand Up @@ -102,7 +102,7 @@ private static String generate(String language, GeneratorInput opts, Type type)
throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "No OpenAPI specification was supplied");
}
} else if (opts.getAuthorizationValue() != null) {
List<AuthorizationValue> authorizationValues = new ArrayList<AuthorizationValue>();
List<AuthorizationValue> authorizationValues = new ArrayList<>();
authorizationValues.add(opts.getAuthorizationValue());
openapi = new OpenAPIParser().readContents(node.toString(), authorizationValues, parseOptions).getOpenAPI();

Expand All @@ -115,7 +115,7 @@ private static String generate(String language, GeneratorInput opts, Type type)

String destPath = null;

if (opts != null && opts.getOptions() != null) {
if (opts.getOptions() != null) {
destPath = opts.getOptions().get("outputFolder");
}
if (destPath == null) {
Expand All @@ -129,7 +129,7 @@ private static String generate(String language, GeneratorInput opts, Type type)

clientOptInput.opts(clientOpts).openAPI(openapi);

CodegenConfig codegenConfig = null;
CodegenConfig codegenConfig;
try {
codegenConfig = CodegenConfigLoader.forName(language);
} catch (RuntimeException e) {
Expand All @@ -150,7 +150,7 @@ private static String generate(String language, GeneratorInput opts, Type type)
try {
List<File> files = new DefaultGenerator().opts(clientOptInput).generate();
if (files.size() > 0) {
List<File> filesToAdd = new ArrayList<File>();
List<File> filesToAdd = new ArrayList<>();
LOGGER.debug("adding to " + outputFolder);
filesToAdd.add(new File(outputFolder));
ZipUtil zip = new ZipUtil();
Expand All @@ -177,7 +177,7 @@ private static String generate(String language, GeneratorInput opts, Type type)
return outputFilename;
}

protected static File getTmpFolder() {
private static File getTmpFolder() {
try {
File outputFolder = File.createTempFile("codegen-", "-tmp");
outputFolder.delete();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public class ZipUtil {
* @throws IOException if IO exception occurs
*/
public void compressFiles(List<File> listFiles, String destZipFile)
throws FileNotFoundException, IOException {
throws IOException {

ZipOutputStream zos = new ZipOutputStream(new FileOutputStream(destZipFile));

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
springfox.documentation.swagger.v2.path=/api-docs
server.servlet.context-path=/api
server.port=8080
spring.jackson.date-format=org.openapitools.codegen.online.RFC3339DateFormat
spring.jackson.serialization.WRITE_DATES_AS_TIMESTAMPS=false

0 comments on commit e3814f5

Please sign in to comment.