io.swagger.models.parameters.Parameter类的使用及代码示例

x33g5p2x  于2022-01-26 转载在 其他  
字(14.9k)|赞(0)|评价(0)|浏览(127)

本文整理了Java中io.swagger.models.parameters.Parameter类的一些代码示例,展示了Parameter类的具体用法。这些代码示例主要来源于Github/Stackoverflow/Maven等平台,是从一些精选项目中提取出来的代码,具有较强的参考意义,能在一定程度帮忙到你。Parameter类的具体详情如下:
包路径:io.swagger.models.parameters.Parameter
类名称:Parameter

Parameter介绍

暂无

代码示例

代码示例来源:origin: apache/servicecomb-java-chassis

public String getParamName(int idx) {
 return swaggerOperation.getParameters().get(idx).getName();
}

代码示例来源:origin: Swagger2Markup/swagger2markup

List<ObjectType> inlineDefinitions = params.inlineDefinitions;
if (config.isFlatBodyEnabled()) {
  List<Parameter> parameters = operation.getOperation().getParameters();
  if (CollectionUtils.isNotEmpty(parameters)) {
    for (Parameter parameter : parameters) {
      if (StringUtils.equals(parameter.getIn(), "body")) {
        ParameterAdapter parameterAdapter = new ParameterAdapter(context,
            operation, parameter, definitionDocumentResolver);
        String description = parameter.getDescription();
        if (isNotBlank(description)) {
          markupDocBuilder.paragraph(markupDescription(config.getSwaggerMarkupLanguage(), markupDocBuilder, description));
        typeInfos.italicText(labels.getLabel(NAME_COLUMN)).textLine(COLON + parameter.getName());
        typeInfos.italicText(labels.getLabel(FLAGS_COLUMN)).textLine(COLON + (BooleanUtils.isTrue(parameter.getRequired()) ? labels.getLabel(FLAGS_REQUIRED).toLowerCase() : labels.getLabel(FLAGS_OPTIONAL).toLowerCase()));

代码示例来源:origin: jooby-project/jooby

Optional.ofNullable(swagger.getTag(value))
   .orElseGet(() -> {
    Tag tag = new Tag().name(value);
    swagger.addTag(tag);
    return tag;
   });
 Optional.ofNullable(swagger.getPath(pattern))
   .orElseGet(() -> {
    Path path = new Path();
Operation op = new Operation();
tags.forEach(it -> op.addTag(it.getName()));
op.operationId(operationId(route, tags.get(0), opIds));
    .stream();
 } else {
  parameter.setName(it.name());
  parameter.setRequired(!it.optional());
  parameter.setDescription(property.getDescription());
  it.description().ifPresent(parameter::setDescription);
  return Stream.of(parameter);

代码示例来源:origin: Swagger2Markup/swagger2markup

List<Parameter> parameters = operation.getParameters();
Map<String, Object> examples = new LinkedHashMap<>();
      abstractSerializableParameterExample = ((AbstractSerializableParameter) parameter).getExample();
      if (abstractSerializableParameterExample == null) {
        abstractSerializableParameterExample = parameter.getVendorExtensions().get("x-example");
        example = parameter.getName() +":\"" +((HeaderParameter) parameter).getType()+ "\"";
      } else if (parameter instanceof PathParameter) {
        String pathExample = (String) examples.get("path");
        pathExample = pathExample.replace('{' + parameter.getName() + '}', encodeExampleForUrl(abstractSerializableParameterExample));
        example = pathExample;
      } else if (parameter instanceof QueryParameter) {
        if (parameter.getRequired())
          String pathExample = path + separator + parameter.getName() + "=" + encodeExampleForUrl(abstractSerializableParameterExample);
          examples.put("path", pathExample);
    examples.put(parameter.getIn(), example);

代码示例来源:origin: AresS31/swurg

logger.info("Info: " + swagger.getInfo());
logger.info("Host: " + swagger.getHost());
logger.info("Base path: " + swagger.getBasePath());
logger.info("Schemes: " + swagger.getSchemes());
logger.info("Consumes: " + swagger.getConsumes());
   .entrySet()) {
  logger.info("HTTP Method: " + operation.getKey().toString());
  logger.info("Schemes: " + operation.getValue().getSchemes());
  logger.info("Consumes: " + operation.getValue().getConsumes());
  logger.info("Produces: " + operation.getValue().getProduces());
  logger.info("Parameters: " + operation.getValue().getParameters());
  for (Parameter parameter : operation.getValue().getParameters()) {
   logger.info("Name: " + parameter.getName());
   logger.info("Type: " + parameter.getIn());
   logger.info("Pattern: " + parameter.getPattern());

代码示例来源:origin: kongchen/swagger-maven-plugin

public Operation parseMethod(String httpMethod, Method method) {
  int responseCode = 200;
  Operation operation = new Operation();
  ApiOperation apiOperation = AnnotationUtils.findAnnotation(method, ApiOperation.class);
    operation.summary(apiOperation.value()).description(apiOperation.notes());
            .schema(responseProperty)
            .headers(defaultResponseHeaders));
        swagger.model(key, models.get(key));
      swagger.model(entry.getKey(), entry.getValue());
        Parameter refParameter = new RefParameter(RefType.PARAMETER.getInternalPrefix() + parameter.getName());
        operation.parameter(refParameter);
      } else {

代码示例来源:origin: apache/cxf

MessageContext ctx = createMessageContext();
String currentBasePath = StringUtils.substringBeforeLast(ctx.getHttpServletRequest().getRequestURI(), "/");
data.setBasePath(currentBasePath);
if (data.getHost() == null) {
  data.setHost(beanConfig.getHost());
if (data.getInfo() == null) {
      subentry.getValue().setTags(Collections.singletonList(tag.getName()));
      OperationResourceInfo ori = methods.get(key);
      subentry.getValue().setSummary(javadocProvider.getMethodDoc(ori));
      for (int i = 0; i < subentry.getValue().getParameters().size(); i++) {
        subentry.getValue().getParameters().get(i).
            setDescription(javadocProvider.getMethodParameterDoc(ori, i));
      addParameters(subentry.getValue().getParameters());

代码示例来源:origin: apache/servicecomb-java-chassis

protected void convertToInterface() {
 if (interfaceCls != null) {
  return;
 }
 ClassConfig classConfig = new ClassConfig();
 classConfig.setClassName(interfaceName);
 classConfig.setIntf(true);
 if (swagger.getPaths() != null) {
  for (Path path : swagger.getPaths().values()) {
   for (Operation operation : path.getOperations()) {
    Response result = operation.getResponses().get(SwaggerConst.SUCCESS_KEY);
    JavaType resultJavaType = swaggerObjectMap.get(result.getSchema());
    MethodConfig methodConfig = new MethodConfig();
    methodConfig.setName(operation.getOperationId());
    methodConfig.setResult(resultJavaType);
    for (Parameter parameter : operation.getParameters()) {
     String paramName = parameter.getName();
     paramName = ClassUtils.correctMethodParameterName(paramName);
     JavaType paramJavaType = ConverterMgr.findJavaType(this, parameter);
     methodConfig.addParameter(paramName, paramJavaType);
    }
    classConfig.addMethod(methodConfig);
   }
  }
 }
 interfaceCls = JavassistUtils.createClass(classLoader, classConfig);
}

代码示例来源:origin: apache/servicecomb-java-chassis

public void init(OperationMeta operationMeta) {
 this.operationMeta = operationMeta;
 Swagger swagger = operationMeta.getSchemaMeta().getSwagger();
 Operation operation = operationMeta.getSwaggerOperation();
 this.produces = operation.getProduces();
 if (produces == null) {
  this.produces = swagger.getProduces();
 }
 this.downloadFile = checkDownloadFileFlag();
 this.createProduceProcessors();
 Method method = operationMeta.getMethod();
 Type[] genericParamTypes = method.getGenericParameterTypes();
 if (genericParamTypes.length != operation.getParameters().size()) {
  throw new Error("Param count is not equal between swagger and method, path=" + absolutePath
    + ";operation=" + operationMeta.getMicroserviceQualifiedName());
 }
 // 初始化所有rest param
 for (int idx = 0; idx < genericParamTypes.length; idx++) {
  Parameter parameter = operation.getParameters().get(idx);
  Type genericParamType = genericParamTypes[idx];
  if ("formData".equals(parameter.getIn())) {
   formData = true;
  }
  RestParam param = new RestParam(idx, parameter, genericParamType);
  addParam(param);
 }
 setAbsolutePath(concatPath(swagger.getBasePath(), operationMeta.getOperationPath()));
}

代码示例来源:origin: AresS31/swurg

public void populateTable(Swagger swagger) {
 DefaultTableModel defaultTableModel = (DefaultTableModel) this.table.getModel();
 List<Scheme> schemes = swagger.getSchemes();
  for (Map.Entry<String, Path> path : swagger.getPaths().entrySet()) {
   for (Map.Entry<HttpMethod, Operation> operation : path.getValue().getOperationMap()
     .entrySet()) {
    StringBuilder stringBuilder = new StringBuilder();
    for (Parameter parameter : operation.getValue().getParameters()) {
     stringBuilder.append(parameter.getName()).append(", ");
      new HttpRequestResponse(
        this.extensionHelper.getBurpExtensionHelpers().buildHttpService(
          swagger.getHost().split(":")[0],
          this.extensionHelper
            .getPort(

代码示例来源:origin: dsukhoroslov/bagri

fullPath += paths.get(0);
Path path = swagger.getPath(fullPath);
if (path == null) {
  path = new Path();
  List<List<String>> values = annotations.get("rest:" + method);
  if (values != null) {
    Operation op = new Operation();
    op.addScheme(Scheme.HTTP);
    op.addScheme(Scheme.HTTPS);
    op.setDescription(fn.getDescription());
    if (consumes != null) {
        pm.setName(pName);
        op.addParameter(pm);
swagger.path(fullPath, path);
logger.debug("afterScan; set path: {}", path.getOperations()); 
if (consumes != null) {
  for (String consume: consumes) {
    swagger.addConsumes(consume);

代码示例来源:origin: org.kill-bill.billing/killbill-jaxrs

if (op.getResponses().containsKey("201") && op.getResponses().containsKey("200")) {
    final Response resp200 =op.getResponses().remove("200");
    final Response resp201 = op.getResponses().get("201");
    if (resp201.getSchema() == null) {
for (Parameter p : op.getParameters()) {
  if (p instanceof BodyParameter) {
    p.setRequired(true);
  } else if (p instanceof PathParameter) {
    p.setRequired(true);
  } else if (p instanceof HeaderParameter) {
    if (p.getName().equals(HDR_CREATED_BY)) {
      p.setRequired(true);

代码示例来源:origin: Sayi/swagger-diff

private String li_changedParam(ChangedParameter changeParam) {
  boolean changeRequired = changeParam.isChangeRequired();
  boolean changeDescription = changeParam.isChangeDescription();
  Parameter rightParam = changeParam.getRightParameter();
  Parameter leftParam = changeParam.getLeftParameter();
  StringBuffer sb = new StringBuffer("");
  sb.append(rightParam.getName());
  if (changeRequired) {
    sb.append(" change into " + (rightParam.getRequired() ? "required" : "not required"));
  }
  if (changeDescription) {
    sb.append(" Notes ").append(leftParam.getDescription()).append(" change into ")
        .append(rightParam.getDescription());
  }
  return sb.toString();
}

代码示例来源:origin: okta/okta-sdk-java

public void removeListAfterAndLimit(Swagger swagger) {
  swagger.getPaths().forEach((pathName, path) ->
    path.getOperations().forEach(operation ->
      operation.getParameters().removeIf(param ->
          !param.getRequired() &&
              ("limit".equals(param.getName()) ||
              "after".equals(param.getName())))
    )
  );
}

代码示例来源:origin: amazon-archives/aws-apigateway-importer

op.getParameters().stream().filter(p -> p.getIn().equals("body")).forEach(p -> {
  BodyParameter bodyParam = (BodyParameter) p;
  Optional<String> inputModel = getInputModel(bodyParam);
    createModel(api, modelName, bodyParam.getSchema(), swagger.getDefinitions(), modelContentType);
    input.getRequestModels().put(modelContentType, modelName);
createMethodResponses(api, method, modelContentType, op.getResponses());
createMethodParameters(api, method, op.getParameters());
createIntegration(method, op.getVendorExtensions());

代码示例来源:origin: org.apache.camel/camel-rest-swagger

@Override
public Producer createProducer() throws Exception {
  final CamelContext camelContext = getCamelContext();
  final Swagger swagger = loadSpecificationFrom(camelContext, specificationUri);
  final Map<String, Path> paths = swagger.getPaths();
  for (final Entry<String, Path> pathEntry : paths.entrySet()) {
    final Path path = pathEntry.getValue();
    final Optional<Entry<HttpMethod, Operation>> maybeOperationEntry = path.getOperationMap().entrySet()
      .stream().filter(operationEntry -> operationId.equals(operationEntry.getValue().getOperationId()))
      .findAny();
    if (maybeOperationEntry.isPresent()) {
      final Entry<HttpMethod, Operation> operationEntry = maybeOperationEntry.get();
      final Operation operation = operationEntry.getValue();
      final Map<String, Parameter> pathParameters = operation.getParameters().stream()
        .filter(p -> "path".equals(p.getIn()))
        .collect(Collectors.toMap(Parameter::getName, Function.identity()));
      final String uriTemplate = resolveUri(pathEntry.getKey(), pathParameters);
      final HttpMethod httpMethod = operationEntry.getKey();
      final String method = httpMethod.name();
      return createProducerFor(swagger, operation, method, uriTemplate);
    }
  }
  final String supportedOperations = paths.values().stream().flatMap(p -> p.getOperations().stream())
    .map(Operation::getOperationId).collect(Collectors.joining(", "));
  throw new IllegalArgumentException("The specified operation with ID: `" + operationId
    + "` cannot be found in the Swagger specification loaded from `" + specificationUri
    + "`. Operations defined in the specification are: " + supportedOperations);
}

代码示例来源:origin: openmrs/openmrs-module-webservices.rest

operation = new Operation();
operation.tag(resourceParentName == null ? resourceName : resourceParentName);
operation.produces("application/json").produces("application/xml");
  q.setRequired(true);
        p.setName(requiredParameter.getName());
        parameterMap.put(requiredParameter.getName(), p);
        p.setName(optionalParameter.getName());
        p.setDescription(buildSearchParameterDependencyString(searchQuery.getRequiredParameters()));
        parameterMap.put(optionalParameter.getName(), p);

代码示例来源:origin: RobWin/assertj-swagger

private void validateParameters(List<Parameter> actualOperationParameters,  List<Parameter> expectedOperationParameters, String httpMethod, String path) {
  String message = String.format("Checking parameters of '%s' operation of path '%s'.", httpMethod, path);
  Map<String, Parameter> actualParametersMap = new HashMap<>();
  for (final Parameter parameter : actualOperationParameters) {
    actualParametersMap.put(parameterUniqueKey(parameter), parameter);
  }
  // All expectedParameters must be there and must match.
  for (final Parameter expectedParameter : expectedOperationParameters) {
    final String parameterName = expectedParameter.getName();
    Parameter actualParameter = actualParametersMap.remove(parameterUniqueKey(expectedParameter));
    String actualParameterNotNullMessage = String.format("%s Expected parameter with name='%s' and in='%s' is missing", message, expectedParameter.getName(), expectedParameter.getIn());
    softAssertions.assertThat(actualParameter).as(actualParameterNotNullMessage).isNotNull();
    validateParameter(actualParameter, expectedParameter, parameterName, httpMethod, path);
  }
  // If there are any extra parameters, these are OK, as long as they are optional.
  for (final Parameter extraParameter : actualParametersMap.values()) {
    String extraParameterNotOptionalMessage = String.format("%s Unexpected parameter with name='%s' and in='%s' is missing", message, extraParameter.getName(), extraParameter.getIn());
    softAssertions.assertThat(extraParameter.getRequired()).as(extraParameterNotOptionalMessage).isFalse();
  }
}

代码示例来源:origin: apache/servicecomb-java-chassis

@Override
 public ParamValueProcessor create(Parameter parameter, Type genericParamType) {
  JavaType targetType = TypeFactory.defaultInstance().constructType(genericParamType);
  return new CookieProcessor(parameter.getName(), targetType, ((CookieParameter) parameter).getDefaultValue(),
    parameter.getRequired());
 }
}

代码示例来源:origin: kongchen/swagger-maven-plugin

protected void updateOperationParameters(List<Parameter> parentParameters, Map<String, String> regexMap, Operation operation) {
  if (parentParameters != null) {
    for (Parameter param : parentParameters) {
      operation.parameter(param);
    }
  }
  for (Parameter param : operation.getParameters()) {
    String pattern = regexMap.get(param.getName());
    if (pattern != null) {
      param.setPattern(pattern);
    }
  }
}

相关文章