使用Swagger注释生成XML名称空间信息

时间:2020-01-24 19:59:30

标签: swagger openapi

我的XML请求如下:

   <ns1: MyRequest ns1="http://example.com/api/2.0">:
        <reference>A request to my endpoint</reference>
   </ns1:MyRequest>

我认为应该在Swagger / OpenAPI 3规范中对其进行建模,如下所示:

MyRequest:
  type: object
  properties:
    reference:
      type: string
      xml:
        name: reference
  xml:
    prefix: ns1
    namespace: https://example.com/api/2.0

是否可以使用JAXB或Swagger注释适当地注释MyRequest.java类,以获取生成的OpenAPI规范中的前缀和名称空间条目?

我尝试如下设置@XmlRootElement上的名称空间属性,但名称空间未出现在生成的OpenAPI规范中。此外,我不能使用该XmlRootElement批注指定前缀。

@XmlRootElement(namespace = "https://example.com/api/2.0")
public class MyRequest{
  //omitted
}

0 个答案:

没有答案