2016-03-11 136 views
3

Swagger 2.0是否支持JAX-RS規範的矩陣參數?Swagger 2.0是否支持矩陣參數?

JAX-RS specificationMatrix-Parameter支持。

我的應用程序中有一些矩陣參數,例如/map/color;lat=50;long=20;scale=32000。 我想推導矩陣參數的招搖。我使用http://editor.wsagger.io;但我在編輯中找不到任何幫助。誰能幫我?

Swagger 2.0是否支持矩陣參數?

ralted以矩陣PARAM其他鏈接:

回答

1

Swagger 2.0 spec沒有提及JAX-RS矩陣參數什麼。

同樣看着swagger-jaxrs的實現,你可以看到在the class@MatrixParam被忽略,負責掃描JAX-RS參數註釋。

+2

有在下一版本的提案,以支持他們。不知道是否會發生,但如果您喜歡,可以按照以下步驟操作:https://github.com/OAI/OpenAPI-Specification/issues/69 – fehguy

0

OpenAPI/Swagger 2.0不支持矩陣參數,但它們將在OpenAPI規範3.0中得到支持。

在OpenAPI的3.0,你的例子:

/map/color;lat=50;long=20;scale=32000 

可以定義爲:

/map/color{params}: 
    get: 
    parameters: 
     - in: path 
     name: params 
     required: true 

     # Named matrix parameters are defined as object properties 
     schema: 
      type: object 
      properties: 
      lat: 
       type: integer 
       example: 50 
      long: 
       type: integer 
       example: 20 
      scale: 
       type: integer 
       example: 32000 

     # Serialize this object as ;prop1=value2;prop2=value2 etc 
     style: matrix 
     explode: true