Question

我尝试使用Swagger Editor指定GET方法的响应。但是当我查看Swagger UI时，响应JSON没有显示。

我的宣言招摇：

 /clients/{id}:
get:
  consumes:
    - application/hal+json
  produces:
    - application/hal+json
  # This is array of GET operation parameters:
  parameters:
    # An example parameter that is in query and is required
    - name: id
      in: path
      required: true
      type: string

  # Expected responses for this operation:
  responses:
    # Response code
    200:
      description: Succes
      # A schema describing your response object.
      # Use JSON Schema format
      schema:
        example:
          application/json: |
            - {"produits":[{"idOffre":{"codeBanque":"038","identifiant":"123"},"idProduit":{"codeBanque":"061","identifiant":"123"}},{"idOffre":{"code":"038","identifiant":"123"},"idProduit":{"code":"061","identifiant":"123"}}]}
    .....

在Swagger UI中，写入响应类（状态200）＆gt;的框。 Model Schema有一个像这样的空json - ＆gt; {}

Answer 1

我不确定swagger-ui是否支持示例，但是我修复了一些错误提示：

example已重命名为examples
examples与schema相同的缩进级别（在您的示例中，example被处理为响应架构的属性，我不确定这是您想要的）< / LI>
schema必须描述响应模型，完成TODO

修正版：

swagger: '2.0'
info:
  title: Clients
  description: API
  version: "1.0.0"
host: api.test.com
schemes:
  - https
basePath: /v1
produces:
  - application/json
paths:
  /clients/{id}:
    get:
      consumes:
        - application/hal+json
      produces:
        - application/hal+json
      parameters:
        - name: id
          in: path
          required: true
          type: string
      responses:
        200:
          description: Succes
          schema:
            type: array
            items:
              properties:
                produits:
                  type: string
                  description: TODO
          examples:
            application/json: |
                - {"produits":[{"idOffre":{"codeBanque":"038","identifiant":"123"},"idProduit":{"codeBanque":"061","identifiant":"123"}},{"idOffre":{"code":"038","identifiant":"123"},"idProduit":{"code":"061","identifiant":"123"}}]}

转换Json响应与描述的招摇

1 个答案: