io.swagger.v3.oas.models.parameters.RequestBody.description()方法的使用及代码示例

x33g5p2x  于2022-01-29 转载在 其他  
字(4.8k)|赞(0)|评价(0)|浏览(124)

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

RequestBody.description介绍

暂无

代码示例

代码示例来源:origin: swagger-api/swagger-core

.addApiResponse("default", errorResponse))
.requestBody(new RequestBody()
    .description("the pet to add")
    .content(new Content().addMediaType("*/*", new MediaType()
        .schema(new Schema().$ref("Person")))));

代码示例来源:origin: swagger-api/swagger-parser

private RequestBody convertParameterToRequestBody(io.swagger.models.parameters.Parameter param, List<String> consumes) {
  RequestBody body = new RequestBody();
  BodyParameter bp = (BodyParameter) param;
  List<String> mediaTypes = new ArrayList<>(globalConsumes);
  if (consumes != null && consumes.size() > 0) {
    mediaTypes.clear();
    mediaTypes.addAll(consumes);
  }
  if (mediaTypes.size() == 0) {
    mediaTypes.add("*/*");
  }
  if (StringUtils.isNotBlank(param.getDescription())) {
    body.description(param.getDescription());
  }
  body.required(param.getRequired());
  Content content = new Content();
  for (String type : mediaTypes) {
    content.addMediaType(type,
        new MediaType().schema(
            convert(bp.getSchema())));
    if (StringUtils.isNotBlank(bp.getDescription())) {
      body.setDescription(bp.getDescription());
    }
  }
  convertExamples(((BodyParameter) param).getExamples(), content);
  body.content(content);
  return body;
}

代码示例来源:origin: io.swagger.parser.v3/swagger-parser-v2-converter

private RequestBody convertParameterToRequestBody(io.swagger.models.parameters.Parameter param, List<String> consumes) {
  RequestBody body = new RequestBody();
  BodyParameter bp = (BodyParameter) param;
  List<String> mediaTypes = new ArrayList<>(globalConsumes);
  if (consumes != null && consumes.size() > 0) {
    mediaTypes.clear();
    mediaTypes.addAll(consumes);
  }
  if (mediaTypes.size() == 0) {
    mediaTypes.add("*/*");
  }
  if (StringUtils.isNotBlank(param.getDescription())) {
    body.description(param.getDescription());
  }
  body.required(param.getRequired());
  Content content = new Content();
  for (String type : mediaTypes) {
    content.addMediaType(type,
        new MediaType().schema(
            convert(bp.getSchema())));
    if (StringUtils.isNotBlank(bp.getDescription())) {
      body.setDescription(bp.getDescription());
    }
  }
  convertExamples(((BodyParameter) param).getExamples(), content);
  body.content(content);
  return body;
}

代码示例来源:origin: org.openapitools.swagger.parser/swagger-parser-v2-converter

private RequestBody convertParameterToRequestBody(io.swagger.models.parameters.Parameter param, List<String> consumes) {
  RequestBody body = new RequestBody();
  BodyParameter bp = (BodyParameter) param;
  List<String> mediaTypes = new ArrayList<>(globalConsumes);
  if (consumes != null && consumes.size() > 0) {
    mediaTypes.clear();
    mediaTypes.addAll(consumes);
  }
  if (mediaTypes.size() == 0) {
    mediaTypes.add("*/*");
  }
  if (StringUtils.isNotBlank(param.getDescription())) {
    body.description(param.getDescription());
  }
  body.required(param.getRequired());
  Content content = new Content();
  for (String type : mediaTypes) {
    content.addMediaType(type,
        new MediaType().schema(
            convert(bp.getSchema())));
    if (StringUtils.isNotBlank(bp.getDescription())) {
      body.setDescription(bp.getDescription());
    }
  }
  convertExamples(((BodyParameter) param).getExamples(), content);
  body.content(content);
  return body;
}

代码示例来源:origin: ppdai-incubator/raptor

/**
 * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#requestBodyObject
 *
 * @param rpc
 * @return
 */
protected RequestBody getRequestBody(Rpc rpc) {
  RequestBody requestBody = new RequestBody();
  ProtoType protoType = rpc.requestType();
  Type type = schmea.getType(protoType);
  requestBody.description(type.documentation());
  requestBody.required(true);
  requestBody.content(getContent(rpc.requestType()));
  return requestBody;
}

代码示例来源:origin: com.atlassian.swagger/atlassian-swagger-doclet

static void processFormParam(Parameter formParameter, Operation operation,
               MethodDoc methodDoc, Components components) {
  Option<Method> methodOpt = ReflectionKit.loadMethod(methodDoc);
  if (methodOpt.isDefined()) {
    Method method = methodOpt.get();
    Consumes methodConsumes = ReflectionUtils.getAnnotation(method, Consumes.class);
    Consumes classConsumes = ReflectionUtils.getAnnotation(method.getDeclaringClass(), Consumes.class);
    RequestBody requestBody = operation.getRequestBody() != null ? operation.getRequestBody() : new RequestBody();
    requestBody.description(formParameter.getDescription());
    if (!Strings.isNullOrEmpty(formParameter.getDescription())) {
      requestBody.setDescription(formParameter.getDescription());
    }
    Content content = processContent(requestBody.getContent(), formParameter.getSchema(),
        methodConsumes, classConsumes, true);
    requestBody.setContent(content);
    setRequestBodyExamples(formParameter, requestBody);
    operation.setRequestBody(requestBody);
  }
}

相关文章