Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
io.starter.ignite.generator.swagger.IgniteGenerator Maven / Gradle / Ivy
package io.starter.ignite.generator.swagger;
import java.io.File;
import java.math.BigDecimal;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.google.common.annotations.VisibleForTesting;
import io.starter.ignite.generator.Configuration;
import io.starter.ignite.generator.DBGen;
import io.starter.ignite.generator.MyBatisJoin;
import io.starter.ignite.generator.SwaggerGen;
import io.swagger.codegen.ClientOptInput;
import io.swagger.codegen.DefaultGenerator;
import io.swagger.codegen.Generator;
import io.swagger.codegen.InlineModelResolver;
import io.swagger.codegen.ignore.CodegenIgnoreProcessor;
import io.swagger.models.ArrayModel;
import io.swagger.models.ComposedModel;
import io.swagger.models.Model;
import io.swagger.models.ModelImpl;
import io.swagger.models.Operation;
import io.swagger.models.Path;
import io.swagger.models.RefModel;
import io.swagger.models.Response;
import io.swagger.models.Swagger;
import io.swagger.models.parameters.BodyParameter;
import io.swagger.models.parameters.Parameter;
import io.swagger.models.parameters.PathParameter;
import io.swagger.models.properties.ObjectProperty;
import io.swagger.models.properties.Property;
import io.swagger.models.properties.PropertyBuilder;
import io.swagger.models.properties.StringProperty;
/**
* Enhance the swagger Code Generation with Starter StackGen features
*
* @author john
*
*/
public class IgniteGenerator extends DefaultGenerator implements Configuration {
// Starter Enhancements
private Boolean generateStarterCRUDOps = true;
private Boolean generateStarterModelEnhancements = true;
private List pluginSwaggers;
IgniteGenerator plugins(List pluginSwaggers) {
this.setPluginSwaggers(pluginSwaggers);
return this;
}
/**
* add any additional custom configs
*
*/
public void preprocessSwagger() {
String port = (System.getProperty("hostPort") != null
? System.getProperty("hostPort")
: Configuration.defaultPort);
config.additionalProperties().put("serverPort", port);
}
@Override
/**
* run the code generator and return the generated source code files
*/
public List generate() {
if (swagger == null || config == null) {
throw new RuntimeException("missing swagger input or config!");
}
configureGeneratorProperties();
configureSwaggerInfo();
// add Starter StackGen code
if (generateStarterModelEnhancements) {
enhanceSwagger();
}
// some static settings
preprocessSwagger();
// resolve inline models
InlineModelResolver inlineModelResolver = new InlineModelResolver();
inlineModelResolver.flatten(swagger);
// TODO: GET CLIENT OPTS, WRAP THE SpringCodeGen
// WRAP codeGenConfig
// opts.getConfig();
// the generated source code files are returned
List files = new ArrayList();
// models
List allModels = new ArrayList();
generateModels(files, allModels);
// apis
List allOperations = new ArrayList();
generateApis(files, allOperations, allModels);
// HDD: add the model link builder here
StackModelRelationGenerator relationGenerator = new StackModelRelationGenerator();
List joins = relationGenerator.generate(swagger);
// create the tables... MyBatis will allow us to modify the
// model later
try {
if (joins.size() > 0)
DBGen.createIDXTables(joins);
} catch (SQLException e) {
logger.error("Failed to create IDX tables.", e);
}
// supporting files
Map bundle = buildSupportFileBundle(allOperations, allModels);
generateSupportingFiles(files, bundle);
config.processSwagger(swagger);
return files;
}
@Override
protected void configureGeneratorProperties() {
// Starter enhancements
generateStarterModelEnhancements = Boolean.valueOf(config
.additionalProperties()
.getOrDefault("igniteGenerateModelEnhancements", new Boolean(
true))
.toString());
generateStarterCRUDOps = Boolean.valueOf(config.additionalProperties()
.getOrDefault("igniteGenerateCRUDOps", new Boolean(true))
.toString());
// end Starter enhancements
super.configureGeneratorProperties();
}
/**
* Add the Starter StackGen required enhancements
*/
@VisibleForTesting
public void enhanceSwagger() {
Set keys = this.swagger.getDefinitions().keySet();
Map priorPaths = this.swagger.getPaths();
this.swagger.setPaths(new HashMap());
for (String k : keys) {
Model m = this.swagger.getDefinitions().get(k);
// put in the ignite fields
addIgniteFields(m);
if (generateStarterCRUDOps) { // optionally add the REST apis
// TODO: see if using the dynamic version is useful
// String path = this.swagger.getBasePath() + "/" + k;
String path = k;
// Path existing =
// this.swagger.getPaths().get(path.toLowerCase());
// IGNITE_GEN_REST_PATH_PREFIX
if (Configuration.checkReservedWord(k)) { // handle reserved
Path ops = addCrudOps(k, m);
if (ops != null) {
this.swagger.getPaths().put(path + "/{param}", ops);
}
Path opsl = addListOp(k, m);
if (opsl != null) {
this.swagger.getPaths()
.put(path + "/list/{searchparam}", opsl);
}
}
}
}
if (priorPaths != null) {
logger.warn("FOUND existing endpoint paths. NOT Generating endpoints for: ");
for (String f : priorPaths.keySet()) {
// TODO: define handling of existing paths
// Path px = priorPaths.get(f);
// this.swagger.getPaths().put(f, px);
logger.warn("Path: " + f);
}
}
}
/**
* @return
*/
private PathParameter getSearchPathParameter() {
PathParameter p = new PathParameter();
p.type("string");
p.setDefaultValue("0");
// p.setPattern("string");
p.setName("searchparam"); // k + "Example");
p.setAccess("public");
p.setDescription("Search example: JSON");
return p;
}
/**
* @param m
* @return
*/
private BodyParameter getBodyPathParameter(String k, Response r) {
RefModel m = new RefModel();
m.set$ref("#/definitions/" + k);
m.setReference(k);
r.responseSchema(m);
r.setDescription("Results fetched OK");
BodyParameter up = new BodyParameter();
up.setName("param");
up.setAccess("public");
up.setDescription("Updated JSON data");
up.setRequired(true);
up.setSchema(m);
return up;
}
/**
* @return
*/
private PathParameter getIdPathParameter() {
PathParameter p = new PathParameter();
p.type("integer");
p.setMinimum(new BigDecimal(0));
// p.setName(k + "ID");
p.setName("param");
p.setAccess("public");
p.setDescription("Retrieve a single result by ID");
p.setRequired(true);
return p;
}
private void addSecurity(String k, Operation loadOp) {
List value;
value = new ArrayList();
value.add("read: items"); // + k);
value.add("write: items"); // " + k);
loadOp.addSecurity("automator_auth", value);
}
private Operation createCRUDOp(String opName, String opType, String opDesc, Parameter p) {
Operation anOp = new Operation();
anOp.setDescription("Starter StackGen Auto Generated " + opName + ":"
+ opType);
anOp.setSummary(opDesc);
// insert of alternate tag
// anOp.addTag("insert-tag");
// 'name' causes dupe method generation
anOp.addTag(opType);
anOp.operationId(opType);
anOp.addParameter(p);
anOp.getVendorExtensions().put("x-tags", "[{tag=" + opType + "}]");
addSecurity(opDesc, anOp);
return anOp;
}
/**
* Adds Starter StackGen required API CRUD REST endpoints.
*
* @param m
* @return
*/
private Path addCrudOps(String k, Model model) {
Path ops = new Path();
// Insert
Response r = new Response();
BodyParameter up = getBodyPathParameter(k, r);
Operation insertOp = createCRUDOp(k, "insert", "Insert a new " + k
+ " into the system", up);
insertOp.addConsumes("application/json");
insertOp.addProduces("application/json");
StringProperty p = new StringProperty("application/json");
r.addHeader("Content-Type", p);
StringProperty s = new StringProperty("text/plain");
r.addHeader("Content-Type", s);
insertOp.response(200, r);
ops.setPost(insertOp);
// Update
r = new Response();
Operation updateOp = createCRUDOp(k, "update", "Update an existing " + k , getIdPathParameter());
up = getBodyPathParameter(k, r);
updateOp.addParameter(up);
updateOp.response(200, r);
ops.setPut(updateOp);
// Delete
Operation deleteOp = createCRUDOp(k, "delete", "Delete an existing " + k
+ " from the system", getIdPathParameter());
updateOp.response(200, r);
ops.setDelete(deleteOp);
// Load
Operation loadOp = createCRUDOp(k, "load", "Load an existing " + k
+ " from the system", getIdPathParameter());
ComposedModel mxt = new ComposedModel();
// mxt.setReference(k);
mxt.setReference("#/definitions/" + k);
r.setResponseSchema(mxt);
loadOp.response(200, r);
ops.setGet(loadOp);
return ops;
}
/**
* Adds Starter StackGen required API CRUD REST endpoints.
*
* @param m
* @param existing
* @return
*/
private Path addListOp(String k, Model model) {
Path ops = new Path();
// List createa a new list path
Operation listOp = new Operation();
listOp.setDescription("Starter StackGen Auto Generated Listing");
listOp.setSummary("Fetch a set of " + k + "s from the system");
// listOp.addTag("list-tag"); // causes dupe method gen
listOp.operationId("list");
Response r = new Response();
ArrayModel m = new ArrayModel();
ObjectProperty objectProp = new ObjectProperty();
m.setItems(objectProp);
m.setReference("#/definitions/" + k);
r.responseSchema(m);
listOp.addResponse("200", r);
// ArrayModel mx = new ArrayModel();
// mx.setReference(k);
// StringProperty p = new StringProperty("#/definitions/" +
// k);
// mx.setItems(p);
// r.setResponseSchema(mx);
PathParameter px = getSearchPathParameter();
listOp.addParameter(px);
// security
// [{automator_auth=[write:Account, read:Account]}]
List value = new ArrayList();
value.add("read: items"); // + k);
listOp.addSecurity("automator_auth", value);
// vendorExtensions
// {x-contentType=application/json,
// x-accepts=application/json, x-tags=[{tag=account}]}
listOp.getVendorExtensions().put("x-contentType", "application/json");
listOp.getVendorExtensions().put("x-accepts", "application/json");
listOp.getVendorExtensions().put("x-tags", "[{tag=" + k + "}]");
// listOp.addTag(k);
ops.setGet(listOp);
return ops;
}
/**
* Adds Starter StackGen required API properties.
*
* API properties are added to the Model objects, and reflected in generated
* Database and Persistence classes.
*
* @param m
*/
private void addIgniteFields(Model mx) {
ModelImpl m = (ModelImpl) mx;
// keyVersion
Map args = new HashMap();
args.put(PropertyBuilder.PropertyId.TITLE, "Securefield Key Version");
args.put(PropertyBuilder.PropertyId.DESCRIPTION, "The version of the SecureField key used to crypt this row (generated column)");
args.put(PropertyBuilder.PropertyId.DEFAULT, "1.0");
Property value = PropertyBuilder.build("integer", "int64", args);
m.addProperty("keyVersion", value);
// keySpec
args = new HashMap();
args.put(PropertyBuilder.PropertyId.TITLE, "Securefield Key Spec");
args.put(PropertyBuilder.PropertyId.READ_ONLY, true);
args.put(PropertyBuilder.PropertyId.DESCRIPTION, "The spec of the SecureField key used to crypt this row (generated column)");
// args.put(PropertyBuilder.PropertyId.MIN_LENGTH, "200");
args.put(PropertyBuilder.PropertyId.DEFAULT, "dev");
args.put(PropertyBuilder.PropertyId.EXAMPLE, "keySource:system");
value = PropertyBuilder.build("string", "", args);
m.addProperty("keySpec", value);
// OwnerId
args = new HashMap();
args.put(PropertyBuilder.PropertyId.TITLE, "StackGen owner id");
args.put(PropertyBuilder.PropertyId.DESCRIPTION, "The ID of the user that owns this data (generated column)");
value = PropertyBuilder.build("integer", "int64", args);
m.addProperty("ownerId", value);
// CreatedDate
args = new HashMap();
args.put(PropertyBuilder.PropertyId.TITLE, "Created Date");
args.put(PropertyBuilder.PropertyId.READ_ONLY, true);
args.put(PropertyBuilder.PropertyId.DESCRIPTION, "The created date for this record/object (generated column)");
value = PropertyBuilder.build("string", "date-time", args);
m.addProperty("createdDate", value);
// ModifiedDate
args = new HashMap();
args.put(PropertyBuilder.PropertyId.TITLE, "Modified Date");
args.put(PropertyBuilder.PropertyId.DESCRIPTION, "The last-modified date for this record/object (generated column)");
value = PropertyBuilder.build("string", "date-time", args);
m.addProperty("modifiedDate", value);
// id -- all objects must have id as primary key
args = new HashMap();
args.put(PropertyBuilder.PropertyId.READ_ONLY, true);
args.put(PropertyBuilder.PropertyId.TITLE, "Id");
args.put(PropertyBuilder.PropertyId.ALLOW_EMPTY_VALUE, false);
args.put(PropertyBuilder.PropertyId.DESCRIPTION, "Primary Key for Object (generated column)");
value = PropertyBuilder.build("integer", "int64", args);
m.addProperty("id", value);
}
/**
* @return the pluginSwaggers
*/
public List getPluginSwaggers() {
return pluginSwaggers;
}
/**
* @param pluginSwaggers the pluginSwaggers to set
*/
public void setPluginSwaggers(List pluginSwaggers) {
this.pluginSwaggers = pluginSwaggers;
}
public Swagger getSwagger() {
return swagger;
}
@Override
public Generator opts(ClientOptInput opts) {
this.opts = opts;
this.swagger = opts.getSwagger();
this.config = opts.getConfig();
this.config.additionalProperties()
.putAll(opts.getOpts().getProperties());
String ignoreFileLocation = this.config.getIgnoreFilePathOverride();
if (ignoreFileLocation != null) {
final File ignoreFile = new File(ignoreFileLocation);
if (ignoreFile.exists() && ignoreFile.canRead()) {
this.ignoreProcessor = new CodegenIgnoreProcessor(ignoreFile);
} else {
LOGGER.warn("Ignore file specified at {} is not valid. This will fall back to an existing ignore file if present in the output directory.", ignoreFileLocation);
}
}
if (this.ignoreProcessor == null) {
this.ignoreProcessor = new CodegenIgnoreProcessor(
this.config.getOutputDir());
}
return this;
}
}
