当前位置: 首页 > 知识库问答 >
问题:

在带有描述的swagger中转换Json响应

班高明
2023-03-14

我尝试使用Swagger编辑器指定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)的框

共有1个答案

唐运诚
2023-03-14

我不确定swagger用户界面是否支持示例,但是我修复了您swagger提取中的一些错误:

  • example重命名为示例
  • 示例模式处于相同的缩进级别(在您的示例中,example被处理为响应模式的属性,我不确定这是您想要的)
  • 架构必须描述响应模型,完成待办事项

固定版本:

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"}}]}
 类似资料:
  • 我正在尝试大摇大摆地记录我的 API,该 API 由泽西Spring 2.22.2 与Spring 4.3 和杰克逊 2.22.2 组成。 我使用的swagger软件包是: endpoint声明之一: 这就是此endpoint生成的 JSON 的样子: 当我试图在swagger编辑器中解析这个输出时,它会返回错误,我认为原因可能是在“paramas”name参数中,它创建了它的对象类型而不是模式。

  • 我通过compojure-api使用ring-swagger。我有几个查询参数,我正在努力寻找一种方法来向单个查询参数添加描述。我可以添加整个endpoint的摘要,但这还不够。 是否可以使用ing-swagger/compojure-api向单个查询参数添加swagger描述?

  • 我试图用Swagger来描述我正在构建的web-api。问题是我无法理解如何描述复杂的json对象? 比如如何描述这个对象:

  • 在Swagger UI中有没有美化响应体中JSON的方法?我用的是SwaggerUIBundle。

  • 是否可以通过 Swagger 描述 Websocket server api? 我们通过websocket服务器广播事件,我想通过一个swagger规范文件来描述它们。 是否有用于WebSocket的文档生成器?

  • 如何在swagger UI中将数组对象传递给参数?这是一个GET请求。我有一个数据类型为Array[]和参数类型为query的请求参数。我已经尝试了下面的阵列,它似乎不工作。我不熟悉招摇的用法。无法解决问题。 型: