Java FormParameter类代码示例

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
private static void initConverters() {
  // inner converters
  for (Class<? extends Property> propertyCls : PROPERTY_MAP.keySet()) {
    addInnerConverter(propertyCls);
  }

  converterMap.put(RefProperty.class, new RefPropertyConverter());
  converterMap.put(ArrayProperty.class, new ArrayPropertyConverter());
  converterMap.put(MapProperty.class, new MapPropertyConverter());
  converterMap.put(StringProperty.class, new StringPropertyConverter());
  converterMap.put(ObjectProperty.class, new ObjectPropertyConverter());

  converterMap.put(ModelImpl.class, new ModelImplConverter());
  converterMap.put(RefModel.class, new RefModelConverter());
  converterMap.put(ArrayModel.class, new ArrayModelConverter());

  converterMap.put(BodyParameter.class, new BodyParameterConverter());

  AbstractSerializableParameterConverter converter = new AbstractSerializableParameterConverter();
  converterMap.put(QueryParameter.class, converter);
  converterMap.put(PathParameter.class, converter);
  converterMap.put(HeaderParameter.class, converter);
  converterMap.put(FormParameter.class, converter);
  converterMap.put(CookieParameter.class, converter);
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
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());
  }
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
@Test
public void testFillFormdataStringParameter() {
	for (int i = 0; i < 100; i++) {
		SwagRequest request = new SwagRequest();

		FormParameter param = new FormParameter();
		param.setIn("formData");
		param.setType("string");
		param.setFormat("date");
		param.setName("testParam");
		param.setRequired(true);

		ParameterGenerator.fillParameter(swagger.getSwagger(), request, param, TestType.VALID);

		assertNotNull(request.getFormDataParameters());
		assertEquals(1, request.getFormDataParameters().size());
		assertTrue(request.getFormDataParameters().containsKey("testParam"));
		assertTrue(request.getFormDataParameters().get("testParam") instanceof String);
	}
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
@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);
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
@Test
public void testFormDataFlagTrue() {
  when(meta.getMethod()).thenReturn(ReflectUtils.findMethod(SomeRestController.class, "form"));
  when(meta.getSwaggerOperation()).thenReturn(operation);
  List<Parameter> params = Arrays.asList(new FormParameter());
  when(operation.getParameters()).thenReturn(params);

  operationMeta.init(meta);

  assertThat(operationMeta.isFormData(), is(true));
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
@Test
public void testCreate() {
  ParamValueProcessorCreator creator =
      ParamValueProcessorCreatorManager.INSTANCE.findValue(FormProcessorCreator.PARAMTYPE);
  FormParameter p = new FormParameter();
  p.setName("p1");

  ParamValueProcessor processor = creator.create(p, String.class);

  Assert.assertEquals(FormProcessor.class, processor.getClass());
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
private Parameter readParam(Swagger swagger, Type type,Class<?> cls, ApiParam param) {
	PrimitiveType fromType = PrimitiveType.fromType(type);
	final Parameter para = null == fromType ? new FormParameter() : new QueryParameter();
	Parameter parameter = ParameterProcessor.applyAnnotations(swagger, para,
			type == null ? String.class : type, null == param ? new ArrayList<Annotation>()
					: Collections.<Annotation> singletonList(param));
	if (parameter instanceof AbstractSerializableParameter) {
		final AbstractSerializableParameter<?> p = (AbstractSerializableParameter<?>) parameter;
		if (p.getType() == null) p.setType(null == fromType ? "string" : fromType.getCommonName());
		p.setRequired(p.getRequired() == true ? true : cls.isPrimitive());
	}
	return parameter;
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
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));
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
@Test
public void returnProperFormDataParam() throws NoSuchMethodException {
    final Method method = getClass().getDeclaredMethod("testFormDataParamRoute", InputStream.class, Part.class);
    final List<Pair<Type, Annotation[]>> parameters = getParameters(method.getGenericParameterTypes(), method.getParameterAnnotations());

    for (final Pair<Type, Annotation[]> parameter : parameters) {
        final Type parameterType = parameter.first();
        final List<Parameter> swaggerParams = new MinijaxSwaggerExtension().extractParameters(Arrays.asList(parameter.second()),
                parameterType, new HashSet<Type>(), SwaggerExtensions.chain());
        assertEquals("file", ((FormParameter) swaggerParams.get(0)).getType());
    }
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
@Override
public Object extract(String name, Parameter parameter, RoutingContext context) {
    FormParameter formParam = (FormParameter) parameter;
    if ("file".equals(formParam.getType())) {
        for (FileUpload file : context.fileUploads()) {
            if (file.name().equals(name)) {
                return file.uploadedFileName();
            }
        }
        if(formParam.getRequired())
            throw new IllegalArgumentException("Missing required parameter: " + name);
        return null;
    } else 
        return this.extract(name, parameter, context.request().formAttributes());
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
private Parameter createParam(String paramType) {
    if ("path".equals(paramType))
        return new PathParameter();
    else if ("query".equals(paramType))
        return new QueryParameter();
    else if ("form".equals(paramType))
        return new FormParameter();
    else if ("formData".equals(paramType))
        return new FormParameter();
    else if ("header".equals(paramType))
        return new HeaderParameter();
    else if ("body".equals(paramType))
        return new BodyParameter();
    return null;
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
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;
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
private String toExampleJsonParameters(Operation operation)
{
    if (operation.getParameters().size() == 1 && operation.getParameters().get(0).getIn().equals("body")) {
        Model model = ((BodyParameter) operation.getParameters().get(0)).getSchema();

        Map<String, Property> properties;
        if (model.getReference() != null) {
            String prefix = "#/definitions/";
            if (model.getReference().startsWith(prefix)) {
                Model model1 = swagger.getDefinitions().get(model.getReference().substring(prefix.length()));
                if (model1 instanceof ArrayModel) {
                    return prettyJson("[" + getValue(((ArrayModel) model1).getItems()) + "]");
                }
                properties = model1.getProperties();
            }
            else {
                throw new IllegalStateException();
            }
        }
        else {
            properties = model.getProperties();
        }
        return prettyJson(toExampleJsonParameters(properties));
    }

    String jsonString = "{" + operation.getParameters().stream()
            .filter(e -> e instanceof FormParameter).map(e -> "\"" + e.getName() + "\" : " + getValue((AbstractSerializableParameter) e))
            .collect(Collectors.joining(", ")) + "}";

    return prettyJson(jsonString);
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
@Test
public void shouldCreateSwaggerFile() throws Exception {
  Swagger swagger = new SwaggerBuilder()
      .build(null, Arrays.asList(route(fileParam("myfile", Upload.class))));
  FormParameter parameter = (FormParameter) swagger
      .getPath("/file")
      .getOperationMap()
      .get(HttpMethod.POST)
      .getParameters()
      .get(0);
  assertEquals("formData", parameter.getIn());
  assertEquals("myfile", parameter.getName());
  assertEquals("file", parameter.getType());
}
 

import io.swagger.models.parameters.FormParameter; //导入依赖的package包/类
@Test
public void shouldCreateSwaggerFiles() throws Exception {
  Swagger swagger = new SwaggerBuilder()
      .build(null, Arrays.asList(route(fileParam("files", Types.listOf(Upload.class)))));
  FormParameter parameter = (FormParameter) swagger
      .getPath("/file")
      .getOperationMap()
      .get(HttpMethod.POST)
      .getParameters()
      .get(0);
  assertEquals("formData", parameter.getIn());
  assertEquals("files", parameter.getName());
  assertEquals("array", parameter.getType());
  assertEquals("file", parameter.getItems().getType());
}