首页 文章

如何编写在请求体中接受XML的swagger API

提问于
浏览 次
0

我们使用Swagger编写REST API . 我们有一个POST服务，它应该接受请求体中的XML文件 . 这是我们的请求定义：

/services/invoke:
    post:
      tags:
        - invoke
      summary: A request invocation
      operationId: invokeUsingPOST
      consumes:
        - application/xml
      produces:
        - application/xml
      parameters:
        - name: User-Token
          in: header
          description: The user token
          required: false
          type: string
        - in: body
          name: request
          description: invoke request XML
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          schema:
            type: string
        '400':
          description: Bad Operation
        '401':
          description: Unauthorized
        '404':
          description: Forbidden

但是，当我们使用swagger-codegen生成Java客户端代码时，生成的方法如下所示：

public String invokeUsingPOST (String userToken, Request request)

并且Request类生成为：

@ApiModel(description = "")
@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-11-25T18:45:31.524+02:00")
public class Request   {
  @Override
  public String toString()  {
    StringBuilder sb = new StringBuilder();
    sb.append("class Request {\n");
    sb.append("}");
    return sb.toString();
  }
}

我如何使用它来发送我的XML？我是否必须从它派生并覆盖toString（）方法，或者有更好的方法吗？

java xml code-generation swagger

2 回答

  • 0

    有一个错误，大约2小时前就解决了 . 请从Swagger-Codegen中提取最新信息，Java API客户端中的参数 request 应该是字符串而不是模型 .

    回复于
  • 1

    对我来说快速解决方法是添加另一个if if serialize方法来检查内容类型是否为“application / xml”

    } else if (contentType.equals("application/xml")) {
            SerializerUtils s = new SerializerUtils();
            return s.serializeRequestBody(contentType, obj);
}

    和SerializerUtils有这两种方法

    public class SerializerUtils {

public Marshaller registerSerializer(Class<?> modelClass) throws JAXBException {
    JAXBContext jaxbContext = JAXBContext.newInstance(modelClass);

    Marshaller jaxbMarshaller = jaxbContext.createMarshaller();
    jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
    return jaxbMarshaller;
}

public RequestBody serializeRequestBody(String contentType, Object obj) {
    StringWriter sw = new StringWriter();
    try {
        registerSerializer(obj.getClass()).marshal(obj, sw);

    } catch (JAXBException e) {
        e.printStackTrace();
    }
    return RequestBody.create(MediaType.parse(contentType), sw.toString());
}

    这对我有用，我希望它有所帮助

    回复于

相关问题