我试图通过使用 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"
当我将其粘贴到online editor时,我得到以下错误,我正在努力弄清楚 .
✖ Swagger Error
Additional properties not allowed: allOf
Jump to line 60
✖ Swagger Error
Not a valid response definition
Jump to line 22
主要问题似乎是 Additional properties not allowed: allOf
,而我似乎在弄清楚我在这种情况下做错了什么 . 我试图声明一个基本的非成功响应,以便所有非200响应都将继承,以便API具有非常标准的非成功响应 . 我的印象是我可以使用 allOf
执行此操作,然后添加或覆盖该响应中的字段 . 我究竟做错了什么?
1 回答
allOf
标记只能用于Schema对象 . 但是,您肯定可以在响应的Schema部分使用它 . 这是一个例子 .