@Override public PathParameter createParameter() { return new PathParameter(); }
@Override public PathParameter createParameter() { return new PathParameter(); }
protected Parameter readImplicitParam(ApiImplicitParam param, Class<?> apiClass) { Parameter parameter; if (param.paramType().equalsIgnoreCase("path")) { parameter = new PathParameter(); } else if (param.paramType().equalsIgnoreCase("query")) { parameter = new QueryParameter(); } else if (param.paramType().equalsIgnoreCase("form") || param.paramType().equalsIgnoreCase("formData")) { parameter = new FormParameter(); } else if (param.paramType().equalsIgnoreCase("body")) { parameter = new BodyParameter(); } else if (param.paramType().equalsIgnoreCase("header")) { parameter = new HeaderParameter(); } else { return null; } return ParameterProcessor.applyAnnotations(swagger, parameter, apiClass, Arrays.asList(new Annotation[]{param})); }
private PathParameter extractPathParam(Type type, String defaultValue, PathParam param) { PathParameter pathParameter = new PathParameter().name(param.value()); if (!Strings.isNullOrEmpty(defaultValue)) { pathParameter.setDefaultValue(defaultValue); } Property schema = ModelConverters.getInstance().readAsProperty(type); if (schema != null) { pathParameter.setProperty(schema); } String parameterType = pathParameter.getType(); if (parameterType == null || parameterType.equals("ref")) { pathParameter.setType("string"); } return pathParameter; }
private PathParameter extractPathVariable(Type type, PathVariable pathVariable) { String paramName = StringUtils.defaultIfEmpty(pathVariable.value(), pathVariable.name()); PathParameter pathParameter = new PathParameter().name(paramName); Property schema = readAsPropertyIfPrimitive(type); if (schema != null) { pathParameter.setProperty(schema); } return pathParameter; }
private static Parameter createParameterInstance(ApiImplicitParam paramAnnotation) { switch (paramAnnotation.paramType()) { case "path": return new PathParameter(); case "query": return new QueryParameter(); case "body": return new BodyParameter(); case "header": return new HeaderParameter(); case "form": return new FormParameter(); case "cookie": return new CookieParameter(); default: throw new Error("not support paramType " + paramAnnotation.paramType()); } }
protected Parameter create() { return new PathParameter(); } },
@Override public PathParameter createParameter() { return new PathParameter(); }
@Override public PathParameter createParameter() { return new PathParameter(); }
@Override protected PathParameter createParameter() { return new PathParameter(); }
public static List<Parameter> getParameters(String uriTemplate) { List<Parameter> parameters = new ArrayList<>(); StringTokenizer stringTokenizer = new StringTokenizer(uriTemplate, "/"); while (stringTokenizer.hasMoreElements()) { String part1 = stringTokenizer.nextToken(); if (part1.contains("{")) { String pathParam = part1.replace("{", "").replace("}", ""); PathParameter parameter = new PathParameter(); parameter.setName(pathParam); parameter.setType("string"); parameters.add(parameter); } } return parameters; }
public static List<Parameter> getParameters(String uriTemplate) { List<Parameter> parameters = new ArrayList<>(); StringTokenizer stringTokenizer = new StringTokenizer(uriTemplate, "/"); while (stringTokenizer.hasMoreElements()) { String part1 = stringTokenizer.nextToken(); if (part1.contains("{")) { String pathParam = part1.replace("{", "").replace("}", ""); PathParameter parameter = new PathParameter(); parameter.setName(pathParam); parameter.setType("string"); parameters.add(parameter); } } return parameters; }
private Parameter paramId() { PathParameter res = new PathParameter(); res.setName(PARAM_NAME_ID); res.setRequired(true); res.setType(StringProperty.TYPE); return res; }
private Parameter buildRequiredUUIDParameter(String name, String desc) { return new PathParameter().name(name).description(desc).type("string"); }
protected Parameter readImplicitParam(ApiImplicitParam param) { final Parameter p; if (param.paramType().equalsIgnoreCase("path")) { p = new PathParameter(); } else if (param.paramType().equalsIgnoreCase("query")) { p = new QueryParameter(); } else if (param.paramType().equalsIgnoreCase("form") || param.paramType().equalsIgnoreCase("formData")) { p = new FormParameter(); } else if (param.paramType().equalsIgnoreCase("body")) { p = null; } else if (param.paramType().equalsIgnoreCase("header")) { p = new HeaderParameter(); } else { LOGGER.warn("Unkown implicit parameter type: [" + param.paramType() + "]"); return null; } final Type type = ReflectionUtils.typeFromString(param.dataType()); return ParameterProcessor .applyAnnotations(swagger, p, type == null ? String.class : type, Collections.singletonList(param)); }
protected Parameter readImplicitParam(ApiImplicitParam param) { final Parameter p; if (param.paramType().equalsIgnoreCase("path")) { p = new PathParameter(); } else if (param.paramType().equalsIgnoreCase("query")) { p = new QueryParameter(); } else if (param.paramType().equalsIgnoreCase("form") || param.paramType().equalsIgnoreCase("formData")) { p = new FormParameter(); } else if (param.paramType().equalsIgnoreCase("body")) { p = null; } else if (param.paramType().equalsIgnoreCase("header")) { p = new HeaderParameter(); } else { LOGGER.warn("Unkown implicit parameter type: [" + param.paramType() + "]"); return null; } final Type type = ReflectionUtils.typeFromString(param.dataType()); return ParameterProcessor .applyAnnotations(swagger, p, type == null ? String.class : type, Collections.singletonList(param)); }
/** * @return the swagger PathParameter for this particular path segment. */ private Parameter getPathParameter() { String typeName = dictionary.getJsonAliasFor(type); Parameter param = new PathParameter() .name(typeName + "Id") .description(typeName + " Identifier") .property(new StringProperty()); return param; }
private static Parameter createParameterInstance(ApiImplicitParam paramAnnotation) { switch (paramAnnotation.paramType()) { case "path": return new PathParameter(); case "query": return new QueryParameter(); case "body": return new BodyParameter(); case "header": return new HeaderParameter(); case "form": return new FormParameter(); case "cookie": return new CookieParameter(); default: throw new Error("not support paramType " + paramAnnotation.paramType()); } }
/** * Build a {@link PathParameter} Swagger object defined by {@link ApiImplicitParam} * to use for documentation. * * @param apiParam The annotation which documents the parameter. * @return The {@link PathParameter} object to be used in {@link Swagger} */ public static PathParameter pathParameter(ApiImplicitParam apiParam) { return new PathParameter() .name(apiParam.name()) .description(apiParam.value()) .required(apiParam.required()) .type(apiParam.dataType()); }
protected Operation generateEntityDeleteOperation(ModelImpl entityModel) { return new Operation() .tag(entityModel.getName()) .produces(APPLICATION_JSON_VALUE) .summary("Deletes the entity: " + entityModel.getName()) .parameter(new PathParameter() .name("entityId") .description("Entity identifier") .required(true) .property(new StringProperty())) .response(200, new Response().description("Success. Entity was deleted.")) .response(403, getErrorResponse("Forbidden. The user doesn't have permissions to delete the entity")) .response(404, getErrorResponse("Not found. MetaClass for the entity with the given name not found.")); }