Swagger 招摇过市:不允许附加属性:allOf
我正试图通过使用Swagger 招摇过市:不允许附加属性:allOf,swagger,swagger-2.0,swagger-editor,Swagger,Swagger 2.0,Swagger Editor,我正试图通过使用allOf来理解这个招摇过市的API继承。这是我的自大yaml文件 swagger: '2.0' info: title: Test API version: '1' basePath: /api/v1 schemes: - https produces: - application/json paths: /users: get: summary: Collection of users tags: - us
allOf
来理解这个招摇过市的API继承。这是我的自大yaml文件
swagger: '2.0'
info:
title: Test API
version: '1'
basePath: /api/v1
schemes:
- https
produces:
- application/json
paths:
/users:
get:
summary: Collection of users
tags:
- users
responses:
200:
description: A list of Users
schema:
$ref: "#/definitions/Users"
500:
$ref: "#/responses/BadRequest"
definitions:
User:
required:
- username
properties:
firstName:
type: string
lastName:
type: string
username:
type: string
Users:
type: array
items:
$ref: "#/definitions/User"
responses:
NonSuccess:
description: Generic response for all non-success responses
schema:
type: object
required:
- code
- message
properties:
code:
type: integer
description: The success code, 0 or -1.
message:
type: string
description: The description message for this success code
errors:
type: array
description: A map of errors within the request. Keyed by the parameter name and the values are the error details
BadRequest:
description: Invalid request parameters
allOf:
- $ref: "#/responses/NonSuccess"
当我将其粘贴到中时,我会遇到以下错误,我很难找出这些错误
✖ Swagger Error
Additional properties not allowed: allOf
Jump to line 60
✖ Swagger Error
Not a valid response definition
Jump to line 22
主要问题似乎是
不允许附加属性:allOf
,而我似乎无法找出在这种情况下我做错了什么。我试图声明一个基本的非成功响应,这样所有的非200响应都将继承,这样API将有一个非常标准的非成功响应。我的印象是,我可以使用allOf
完成这项操作,然后添加或覆盖该响应中的字段。我到底做错了什么?allOf标记只能用于模式对象。不过,您完全可以在响应的模式部分使用它。这里有一个例子
swagger: '2.0'
info:
title: Test API
version: '1'
basePath: /api/v1
schemes:
- https
produces:
- application/json
paths:
/users:
get:
summary: Collection of users
tags:
- users
responses:
200:
description: A list of Users
schema:
$ref: "#/definitions/Users"
500:
$ref: "#/responses/BadRequest"
definitions:
User:
required:
- username
properties:
firstName:
type: string
lastName:
type: string
username:
type: string
Users:
type: array
items:
$ref: "#/definitions/User"
Response:
type: object
required:
- code
- message
properties:
code:
type: integer
description: The success code, 0 or -1.
message:
type: string
description: The description message for this success code
errors:
type: array
description: A map of errors within the request. Keyed by the parameter name and the values are the error details
BadRequest:
type: object
required:
- validationErrors
properties:
validationErrors:
type: array
items:
type: string
responses:
NonSuccess:
description: Generic response for a non-success
schema:
$ref: "#/definitions/Response"
BadRequest:
description: Invalid request parameters
schema:
allOf:
- $ref: "#/definitions/Response"
- $ref: "#/definitions/BadRequest"
叶,这就是我的结局。