@Override public HeaderParameter createParameter() { return new HeaderParameter(); }
@Override public HeaderParameter createParameter() { return new HeaderParameter(); }
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 HeaderParameter extractHeaderParam(Type type, String defaultValue, HeaderParam param) { HeaderParameter headerParameter = new HeaderParameter().name(param.value()); if (!Strings.isNullOrEmpty(defaultValue)) { headerParameter.setDefaultValue(defaultValue); } Property schema = ModelConverters.getInstance().readAsProperty(type); if (schema != null) { headerParameter.setProperty(schema); } String parameterType = headerParameter.getType(); if (parameterType == null || parameterType.equals("ref") || parameterType.equals("array")) { headerParameter.setType("string"); } return headerParameter; }
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()); } }
private HeaderParameter extractRequestHeader(Type type, RequestHeader requestHeader) { String paramName = StringUtils.defaultIfEmpty(requestHeader.value(), requestHeader.name()); HeaderParameter headerParameter = new HeaderParameter().name(paramName) .required(requestHeader.required()); Property schema = readAsPropertyIfPrimitive(type); if (!DEFAULT_VALUE.equals(requestHeader.defaultValue())) { headerParameter.setDefaultValue(requestHeader.defaultValue()); headerParameter.setRequired(false); } if (schema != null) { headerParameter.setProperty(schema); } return headerParameter; }
protected Parameter create() { return new HeaderParameter(); } },
@Override public HeaderParameter createParameter() { return new HeaderParameter(); }
@Override protected HeaderParameter createParameter() { return new HeaderParameter(); }
@Override public HeaderParameter createParameter() { return new HeaderParameter(); }
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("Unknown implicit parameter type: [{}]", param.paramType()); return null; } final Type type = ReflectionUtils.typeFromString(param.dataType()); return ParameterProcessor.applyAnnotations(swagger, p, (type == null) ? String.class : type, Arrays.<Annotation>asList(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)); }
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("Unknown implicit parameter type: [{}]", param.paramType()); return null; } final Type type = param.dataTypeClass() == Void.class ? ReflectionUtils.typeFromString(param.dataType()) : param.dataTypeClass(); if (type == null) { LOGGER.error("no dataType defined for implicit param `{}`! resolved parameter will not have a type defined, and will therefore be not compliant with spec. see https://github.com/swagger-api/swagger-core/issues/2556.", param.name()); } return ParameterProcessor.applyAnnotations(swagger, p, (type == null) ? String.class : type, Arrays.<Annotation>asList(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("Unknown implicit parameter type: [{}]", param.paramType()); return null; } final Type type = param.dataTypeClass() == Void.class ? ReflectionUtils.typeFromString(param.dataType()) : param.dataTypeClass(); if (type == null) { LOGGER.error( "no dataType defined for implicit param `{}`! resolved parameter will not have a type defined, and will therefore be not compliant with spec. see https://github.com/swagger-api/swagger-core/issues/2556.", param.name()); } return ParameterProcessor.applyAnnotations(swagger, p, (type == null) ? String.class : type, Arrays.<Annotation>asList(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()); } }
protected Parameter readImplicitParam(ApiImplicitParam param) { final AbstractSerializableParameter 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("Unknown implicit parameter type: [" + param.paramType() + "]"); return null; } p.setName(param.name()); p.setType(param.dataType()); p.setDefaultValue(param.defaultValue()); p.setAccess(param.access()); final Type type = typeFromString(param.dataType()); return ParameterProcessor.applyAnnotations(swagger, p, type == null ? String.class : type, Arrays.<Annotation>asList(param)); }
/** * Build a {@link HeaderParameter} Swagger object defined by {@link ApiImplicitParam} * to use for documentation. * * @param apiParam The annotation which documents the parameter. * @return The {@link HeaderParameter} object to be used in {@link Swagger} */ public static HeaderParameter headerParameter(ApiImplicitParam apiParam) { return new HeaderParameter() .name(apiParam.name()) .description(apiParam.value()) .required(apiParam.required()) .type(apiParam.dataType()); }
@Override public Parameter mToParameter(String name, Framework.Mapping<?> mapping) { if (isEmpty( attach(mapping).in() )) throw new IllegalArgumentException("in is required!!!"); if ("body".equalsIgnoreCase(attach(mapping).in())) { return new BodyParameter() .schema(mToModel(mapping)) .name(name) .description(attach(mapping).desc()); } if (isEmpty(name)) throw new IllegalArgumentException("name is required!!!"); if (!isPrimitive(mapping)) throw new IllegalArgumentException("must be primitives or primitive list!!!"); if ("form".equalsIgnoreCase( attach(mapping).in() ) || "formData".equalsIgnoreCase( attach(mapping).in() )) { return fillParameter(new FormParameter(), mapping).name(name); } if ("path".equalsIgnoreCase( attach(mapping).in() )) { return fillParameter(new PathParameter(), mapping).name(name).required(true); } if ("query".equalsIgnoreCase( attach(mapping).in() )) { return fillParameter(new QueryParameter(), mapping).name(name); } if ("cookie".equalsIgnoreCase( attach(mapping).in())) { return fillParameter(new CookieParameter(), mapping).name(name); } if ("header".equalsIgnoreCase( attach(mapping).in() )) { return fillParameter(new HeaderParameter(), mapping).name(name); } throw new IllegalArgumentException("Unsupported in type: '" + attach(mapping).in() + "'!!!"); }
public HeaderParameter getMessageHeaderParameter(final MessageParameter parameter) { final HeaderParameter swaggerParameter = new HeaderParameter(); boolean _isArrayProperty = this._jsonSchemaHelper.isArrayProperty(parameter); if (_isArrayProperty) { final Property items = this.createSwaggerPropertyWithConstraints(parameter); ArrayProperty _arrayProperty = new ArrayProperty(items); swaggerParameter.setProperty(_arrayProperty); } else { swaggerParameter.setProperty(this.createSwaggerPropertyWithConstraints(parameter)); } swaggerParameter.setDescription(this._zenModelHelper.getDocumentation(parameter)); swaggerParameter.setName(parameter.getName()); swaggerParameter.setRequired(parameter.isRequired()); this.setVendorExtensions(parameter, swaggerParameter); return swaggerParameter; }