Refine search
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 FormParameter extractFormParameter(Type type, String defaultValue, FormParam param) { FormParameter formParameter = new FormParameter().name(param.value()); if (!Strings.isNullOrEmpty(defaultValue)) { formParameter.setDefaultValue(defaultValue); } Property schema = ModelConverters.getInstance().readAsProperty(type); if (schema != null) { formParameter.setProperty(schema); } String parameterType = formParameter.getType(); if (parameterType == null || parameterType.equals("ref") || parameterType.equals("array")) { formParameter.setType("string"); } return formParameter; } }
private boolean isPart(Parameter parameter) { //only check FormParameter formParameter = (FormParameter) parameter; if ("array".equals(formParameter.getType())) { Property items = formParameter.getItems(); return new FileProperty().getType().equals(items.getType()); } return new FileProperty().getType().equals(formParameter.getType()); }
@Override public void process(OperationGenerator operationGenerator, int paramIdx) { FormParameter parameter = new FormParameter(); parameter.setType(new FileProperty().getType()); parameter.setName(ParamUtils.getParameterName(operationGenerator.getProviderMethod(), paramIdx)); operationGenerator.addProviderParameter(parameter); } }
bodyParameter.setRequired(true); formParameter = new FormParameter() .name(FORM_PARAM_NAME) .description(FORM_PARAM_VALUE) .required(false) .type(SwaggerDocumentation.DataTypes.DATA_TYPE_STRING); headerParameter = new HeaderParameter() .name(HEADER_PARAM_NAME) .description(HEADER_PARAM_VALUE) .required(true) .type(SwaggerDocumentation.DataTypes.DATA_TYPE_STRING); .type(SwaggerDocumentation.DataTypes.DATA_TYPE_STRING); queryParameter = new QueryParameter() .name(QUERY_PARAM_NAME) .description(QUERY_PARAM_VALUE) .required(true) .type(SwaggerDocumentation.DataTypes.DATA_TYPE_STRING);
HeaderParameter headerParameter = new HeaderParameter(); if (Strings.isNullOrEmpty(header.value())) { headerParameter.setName(methodParameterName); } else { headerParameter.setName(header.value()); FormParameter formParameter = new FormParameter(); formParameter.setName(methodParameterName); formParameter.setDescription(getDescription(methodParameter)); setPropertyType(swagger, formParameter, method); QueryParameter queryParameter = new QueryParameter(); queryParameter.setName(methodParameterName); queryParameter.setDescription(getDescription(methodParameter)); setPropertyType(swagger, queryParameter, method);
FormParameter fp = null; if (parameterType.isArray()) { fp = new FormParameter().type("array").name(_parameter.getName()); Property property = new FileProperty(); fp.setItems(property); } else { fp = new FormParameter().type("file").name(_parameter.getName()); QueryParameter fp = new QueryParameter().name(_parameter.getName()); Property schema = createProperty(type); if (schema != null) { fp.setProperty(schema); HeaderParameter hp = new HeaderParameter().name(_parameter.getName()); Property schema = createProperty(type); if (schema != null) { hp.setProperty(schema);
if (annotation instanceof QueryParam) { QueryParam param = (QueryParam) annotation; QueryParameter qp = new QueryParameter() .name(param.value()); qp.setProperty(schema); } else if (annotation instanceof HeaderParam) { HeaderParam param = (HeaderParam) annotation; HeaderParameter hp = new HeaderParameter() .name(param.value()); Property schema = createProperty(type); if (schema != null) { hp.setProperty(schema); } else if (annotation instanceof FormParam) { FormParam param = (FormParam) annotation; FormParameter fp = new FormParameter() .name(param.value()); Property schema = createProperty(type); if (schema != null) { fp.setProperty(schema);
private Parameter getParameterFromURITemplateParam(URITemplateParam uriTemplateParam) { switch (uriTemplateParam.getParamType()) { case BODY: return getDefaultBodyParameter(); case PATH: PathParameter pathParameter = new PathParameter(); pathParameter.setName(uriTemplateParam.getName()); pathParameter.setType(uriTemplateParam.getDataType()); return pathParameter; case QUERY: QueryParameter queryParameter = new QueryParameter(); queryParameter.setName(uriTemplateParam.getName()); queryParameter.setType(uriTemplateParam.getDataType()); return queryParameter; case FORM_DATA: FormParameter formParameter = new FormParameter(); formParameter.setName(uriTemplateParam.getName()); formParameter.setType(uriTemplateParam.getDataType()); return formParameter; default: return null; } }
pm = new FormParameter().type(param.getType()); break; pm = new HeaderParameter().type(param.getType()); break; pm = new QueryParameter().type(param.getType()); break;
output = p; } else if (ParamType.QUERY.equals(param.getParamType())) { QueryParameter p = new QueryParameter(); p.setDefaultValue(param.getDefaultValue()); p.setEnum(_enum); output = p; } else if (ParamType.HEADER.equals(param.getParamType())) { HeaderParameter p = new HeaderParameter(); p.setDefaultValue(param.getDefaultValue()); p.setEnum(_enum); output = p; } else if (ParamType.BODY.equals(param.getParamType())) { output = p; } else if (ParamType.FORM.equals(param.getParamType())) { FormParameter p = new FormParameter(); p.setDefaultValue(param.getDefaultValue()); p.setEnum(_enum); output = p;
break; case "query": QueryParameter qParam = new QueryParameter(); String attrType = ConverterUtils .getStringLiteralValue(paramAttributes.get(ConverterConstants.ATTR_TYPE)).trim(); break; qParam.setType(type); param = qParam; break; case "header": param = new HeaderParameter(); break; case "cookie": break; case "form": param = new FormParameter(); break; case "path":
@Override public FormParameter createParameter() { return new FormParameter(); } }
/** * Build a {@link FormParameter} Swagger object defined by {@link ApiImplicitParam} * to use for documentation. * * @param apiParam The annotation which documents the parameter. * @return The {@link FormParameter} object to be used in {@link Swagger} */ public static FormParameter formParameter(ApiImplicitParam apiParam) { return new FormParameter() .name(apiParam.name()) .description(apiParam.value()) .required(apiParam.required()) .type(apiParam.dataType()); }
private Parameter readImplicitParam(Swagger swagger, ApiImplicitParam param) { PrimitiveType fromType = PrimitiveType.fromName(param.paramType()); final Parameter p = null == fromType ? new FormParameter() : new QueryParameter(); final Type type = ReflectionUtils.typeFromString(param.dataType()); return ParameterProcessor.applyAnnotations(swagger, p, type == null ? String.class : type, Collections.<Annotation> singletonList(param)); }
private FormParameter extractRequestPart(Type type, RequestPart requestPart) { String paramName = StringUtils.defaultIfEmpty(requestPart.value(), requestPart.name()); FormParameter formParameter = new FormParameter().name(paramName) .required(requestPart.required()); JavaType ct = constructType(type); Property schema; if (MultipartFile.class.isAssignableFrom(ct.getRawClass())) { schema = new FileProperty(); } else if (ct.isContainerType() && MultipartFile.class.isAssignableFrom(ct.getContentType().getRawClass())) { schema = new ArrayProperty().items(new FileProperty()); } else { schema = ModelConverters.getInstance().readAsProperty(type); } if (schema != null) { formParameter.setProperty(schema); } return formParameter; }
@Override public void process(OperationGenerator operationGenerator, int paramIdx) { FormParameter parameter = new FormParameter(); parameter.setName(ParamUtils.getParameterName(operationGenerator.getProviderMethod(), paramIdx)); Property property = new ArrayProperty(new FileProperty()); parameter.setProperty(property); operationGenerator.addProviderParameter(parameter); } }
@Override public List<Parameter> extractParameters(List<Annotation> annotations, Type type, Set<Type> typesToSkip, Iterator<SwaggerExtension> chain) { if (shouldIgnoreType(type, typesToSkip)) { // stop the processing chain return Collections.emptyList(); } for (Annotation annotation : annotations) { if (annotation instanceof FormDataParam) { final FormDataParam fd = (FormDataParam) annotation; final Class<?> cls = TypeFactory.defaultInstance().constructType(type).getRawClass(); final Parameter param; if (java.io.InputStream.class.isAssignableFrom(cls)) { param = new FormParameter().type("file").name(fd.value()); } else { FormParameter fp = new FormParameter().name(fd.value()); Property schema = ModelConverters.getInstance().readAsProperty(type); if (schema != null) { fp.setProperty(schema); } param = fp; } return Collections.singletonList(param); } } return super.extractParameters(annotations, type, typesToSkip, chain); }
public List<Parameter> extractParameters(Annotation[] annotations, Type type) { String defaultValue = null; List<Parameter> parameters = new ArrayList<>(); Parameter parameter = null; for (Annotation annotation : annotations) { if (annotation instanceof ApiParam) { FormParameter qp = new FormParameter() .name(((ApiParam) annotation).value()); qp.setDefaultValue(defaultValue); Property schema = modelConverters.readAsProperty(type); if (schema != null) { qp.setProperty(schema); if (schema instanceof ArrayProperty) { qp.setItems(((ArrayProperty) schema).getItems()); } } parameter = qp; } } if (parameter != null) { parameters.add(parameter); } return parameters; }
return getTypeInfo( serviceBuilder, parameter.getType(), parameter.getFormat(), null, parameter.getItems()); return getTypeInfo( serviceBuilder, parameter.getType(), parameter.getFormat(), null, parameter.getItems()); return getTypeInfo( serviceBuilder, parameter.getType(), parameter.getFormat(), null, parameter.getItems());