OpenAPI 3-同时显示参数和架构描述

时间:2020-02-27 15:35:42

标签: swagger documentation openapi

使用OpenAPI 3(.0.3),我试图记录一些参数,这些参数会重复大量的常规信息,但有具体的说明。

例如,我有一个target模式,如下所示:

use_local_label:
        push    edi                                # save call-preserved regs
        push    ebx
        sub     esp, 20
        mov     DWORD PTR [esp+12], OFFSET FLAT:.L4   # volatile init
        mov     ebx, DWORD PTR [esp+32]               # p = function arg
        mov     edi, DWORD PTR [esp+12]               # target = volatile reload
.L4:
        call    ext
        add     DWORD PTR [ebx], 1
        je      .L5                # if = conditional jump over the goto
        jmp     edi                # goto *target, normally to .L4
.L5:
        add     esp, 20
        mov     eax, 1
        pop     ebx
        pop     edi
        ret

然后我想将其用作参数的架构(例如):

Date

问题是,如果我提供了对该参数的描述,则不会显示schema参数,因此您看不到任何有关格式的信息(除了在该格式中将显示type: string format: date description: > Format: `YYYY-MM-DD` (`full-date` defined in [RFC3339] (https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)) 之外)特殊的情况,因为我使用的是定义的格式...但是并非总是如此。

我知道我可以复制-粘贴模式描述并将其手动添加到参数的描述中,但是有很多这样的选择,甚至不能单独定义模式。

是否有一种干净的方法可以对此进行记录,以便使这两部分信息都显示出来而无需我重复我自己?

如果有关系,我将同时提供ReDoc和Swagger-UI的信息。他们在这方面似乎是一致的。

0 个答案:

没有答案