Swagger Annotation - 没有参数时不包含参数?

时间:2015-04-09 20:43:36

标签: java rest swagger swagger-editor

我有一个与Drop-wizard集成的swagger-jersey2-jaxrs 1.5.1-M2。我已经使用我在资源和模型中包含的swagger注释生成了以下yaml:

    ---
swagger: "2.0"
info:
  version: "1.0.0"
  title: "test Application"
tags:
- name: "test"
paths:
  /v1/test/version:
    get:
      tags:
      - "v1test"
      summary: "version number of test"
      description: "Returns version number of test"
      operationId: "getVersionAndBuildInfo"
      produces:
      - "application/json"
      parameters: 
      responses:
        404:
          description: "build number not found."
        200:
          description: "successful operation"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/testInformation"
definitions:
  testInformation:
    properties:
      build:
        type: "string"
        description: "test build number"
      version:
        type: "string"
        description: "test version number"
      buildTimestamp:
        type: "string"
        description: "test build timestamp"
    description: "model for test version information"

注意参数:包含在swagger生成的yaml中。当我在swagger编辑器2.0中粘贴它时,它会抛出错误说"数组太短(0),最小1"。

当网址不需要任何参数时,有没有办法在yaml中生成参数:?我没有包含任何参数注释,它仍然显示在生成的yaml上。

1 个答案:

答案 0 :(得分:0)

我们在Swagger定义的JSON Schema中有一个错误,它没有允许空参数。这是固定的,很快就会出现在swagger-editor中。

请按照https://github.com/swagger-api/swagger-editor/issues/395查看更新时间。

没有必要试图解决问题。这个问题在生成过程中因为输出没有错误。