Documentation 对象中的招摇过市继承
我想记录一些包装好的json文档:Documentation 对象中的招摇过市继承,documentation,swagger,Documentation,Swagger,我想记录一些包装好的json文档: Action: required: - description - name properties: description: type: string format: string name: type: string format: string Actor: required: - gpn p
Action:
required:
- description
- name
properties:
description:
type: string
format: string
name:
type: string
format: string
Actor:
required:
- gpn
properties:
gpn:
type: string
format: string
Object:
required:
- image
- type
- url
properties:
image:
type: string
format: string
type:
type: string
format: string
url:
type: string
format: string
CreateActivity:
required:
- action
- actor
- object
- title
- externalID
properties:
action:
$ref: Action
actor:
$ref: Actor
object:
$ref: Object
title:
type: string
format: string
externalID:
type: string
format: string
我已经大摇大摆地用$ref
声明了这一点
路径:
/activity:
get:
description: Returns an activity
operationId: fetchActivity
produces:
- application/json
parameters:
- name: externalActivityID
in: query
required: true
type: string
responses:
200:
description: existing activity
schema:
$ref: CreateActivity
default:
description: unexpected error
schema:
$ref: ErrorModel
结果并不是我所期望的(我从宠物店模仿了这种方法)。我想要一个具有链接条目的对象(即Action、Actor和object在CreateActivity中,具有字段名),并将请求链接到CreateActivity对象
屏幕截图显示了实际情况:
缺少“子对象”的对象
以及swagger文档中缺失的链接:
这是一个已知的问题 请看这里-
另外,当您使用
“type”:“string”
时,不需要添加“format”:“string”
,因为它不向其中添加任何信息。“格式”
字段用于精细定义“类型”
谢谢,我将更改此字段。在修复程序准备好之前是否有解决方法?我不知道。不过,它不应该直接影响您的工作,因为编辑器用于构建API文档,而不是显示它。预览窗格更便于查看API是否按预期显示。您仍然可以使用swagger ui来正确显示您的规范。我投票将此问题作为离题问题结束,因为。请参阅如何解决有关产品中有缺陷功能的问题?(关闭原因的Dup)