在swagger API文档中将描述的一部分切换为内部



我有一个在swagger中记录的API,我想有一些切换,使描述的某个部分成为内部的。

parameter:
- name: abc
description: |
line1
line2
line3

在上面的例子中,是否可以引入某种切换,从而使第3行不会显示在最终文档中。我使用openapi-filter.js将对象和属性标记为x-internal,但我不知道如何切换描述的一部分。

OpenAPI中没有任何功能(据我所知,Swagger中也没有(可以像您描述的那样隐藏部分描述。我建议您使用自己的x-internal-info字段或可以为适当的受众解析的内容。对不起,这不是你所希望的答案!

相关内容

最新更新