openapi 3.0 - перейти от массива к словарю / хэш-карте - PullRequest
Новая
       11

openapi 3.0 - перейти от массива к словарю / хэш-карте

0 голосов
/ 07 ноября 2018

Это в основном пример инвентаря из Swagger Hub с несколькими элементами, измененными внутри массива. Вот как выглядит ответ, когда я делаю запрос Python на свой URL-адрес SwaggerHub: 

[{
    "hostname": "server",
    "ip_addr": "192.168.0.12",
    "app_name": "generic",
    "app_code": 12345678,
    "xmx": "5678",
    "jvm_version": "1.0.0",
    "xms": "1234"
}]

Как я могу изменить код, чтобы это был словарь? Я не могу поверить, сколько строк YAML требуется, чтобы сделать то, что может сделать Flask или Falcon, примерно за 5 строк кода.

В любом случае, вот шаблон: 

openapi: 3.0.0
# Added by API Auto Mocking Plugin
servers:
  - description: SwaggerHub API Auto Mocking
    url: https://virtserver.swaggerhub.com/james_test/test/1.0.0
info:
  description: This is a simple API
  version: "1.0.0"
  title: Simple Inventory API
  contact:
    email: you@your-company.com
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
  - name: admins
    description: Secured Admin-only calls
  - name: developers
    description: Operations available to regular developers
paths:
  /data:
    get:
      tags:
        - developers
      summary: get random data from james_test API
      operationId: searchInventory
      description: |
        By passing in the appropriate options, you can search for
        available inventory in the system
      responses:
        '200':
          description: search results matching criteria
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/state_data'
        '400':
          description: bad input parameter
components:
  schemas:
    state_data:
      type: object
      required:
        - app_code
        - app_name
        - jvm_version
        - hostname
        - ip_addr
        - xms
        - xmx
      properties:
        app_code:
          type: integer
          format: int64
          example: 12345678
        app_name:
          type: string
          example: generic
        jvm_version:
          type: string
          format: string
          example: '1.0.0'
        hostname:
          type: string
          format: hostname
          example: 'server'
        ip_addr:
          type: string
          format: ipv4
          example: '192.168.0.12'
        xms:
          type: string
          format: string
          example: '1234'
        xmx:
          type: string
          format: string
          example: '5678'

Спасибо всем.

Edit:

Я надеялся получить ответ, подобный этому: 

{
    "hostname": "server",
    "ip_addr": "192.168.0.12",
    "app_name": "generic",
    "app_code": 12345678,
    "xmx": "5678",
    "jvm_version": "1.0.0",
    "xms": "1234"
}

1 Ответ

0 голосов
/ 08 ноября 2018

Ложный сервер SwaggerHub возвращает массив, потому что ваш ответ определен как массив: 

          content:
            application/json:
              schema:
                type: array   # <----
                items:
                  $ref: '#/components/schemas/state_data'

Чтобы получить ответ объекта, используйте: 

          content:
            application/json:
              schema:
                $ref: '#/components/schemas/state_data'
...