这是我在 Swagger 编辑器在线查看的 OpenAPI 3.0 定义的简化版本。我试图获得错误代码 401 和 403 的两个响应,它们共享相同的架构,显示不同的示例 - 这似乎不起作用,我仍然看到引用的类型作为示例。
你能帮我找出这些定义有什么问题吗?
openapi: 3.0.0
info:
version: '1.0'
title: A service
paths:
/doSomething:
post:
requestBody:
content:
application/json:
schema:
type: string
example: A string
responses:
401:
$ref: '#/components/responses/Unauthorized'
403:
$ref: '#/components/responses/Denied'
components:
responses:
Unauthorized:
description: The endpoint cannot be reached because the request is not authorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: unauthorized
Denied:
description: The request's authorizations don't match the required ones needed to access the resource
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: permissions denied
schemas:
Error:
type: object
properties:
error:
type: string
最佳答案
您的定义是正确的,响应示例
显示在 Swagger Editor 3.6.5+ 和 Swagger UI 3.17.4+ 中。此外,Swagger UI 3.23.0+ 和 Editor 3.6.31+ 支持多个示例
。
关于Swagger/OpenAPI 3.0 问题及响应示例,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/48551855/