我正在为其编写 Swagger 2.0 规范的 API 基本上是任何 JSON 值的存储。
我想要一个读取值的路径和一个存储非预定义深度的任何 JSON 值(null、数字、整数、字符串、对象、数组)的路径。
不幸的是,Swagger 2.0 似乎对输入和输出的模式非常严格,并且不允许 JSON Schema 允许的整个模式集。Swagger 编辑器不允许混合值(例如,可以是布尔值或整数的属性)或松散定义的数组(必须严格定义项目的类型)和对象。
所以我正在尝试通过定义MixedValue
模式来解决问题:
---
swagger: '2.0'
info:
version: 0.0.1
title: Data store API
consumes:
- application/json
produces:
- application/json
paths:
/attributes/{attrId}/value:
parameters:
- name: attrId
in: path
type: string
required: true
get:
responses:
'200':
description: Successful.
schema:
$ref: '#/definitions/MixedValue'
put:
parameters:
- name: value
in: body
required: true
schema:
$ref: '#/definitions/MixedValue'
responses:
responses:
'201':
description: Successful.
definitions:
MixedValue:
type: object
properties:
type:
type: string
enum:
- 'null'
- boolean
- number
- integer
- string
- object
- array
boolean:
type: boolean
number:
type: number
integer:
type: integer
string:
type: string
object:
description: deep JSON object
type: object
additionalProperties: true
array:
description: deep JSON array
type: array
required:
- type
但是 Swagger Editor 拒绝松散定义的object
和array
属性。
问题: - 有没有办法解决这个问题?- 它只是 Swagger 编辑器错误还是 Swagger 2.0 规范的强限制?- 有没有更好的方法(最佳实践)来指定我需要什么?- 我的 API 规范是否可以预期 swagger 为某些语言生成的代码存在一些限制?