如何解决在swagger API文档中将部分描述切换为内部
我有一个用草率记录的API,我想进行某种切换以使描述的某些部分成为内部。
parameter:
- name: abc
description: |
line1
line2
line3
在上面的示例中,可以引入某种形式的切换,以便在最终文档中不显示第3行。我正在使用openapi-filter.js将对象和属性标记为x-internal,但是我不知道如何执行此操作来切换描述的一部分。
解决方法
OpenAPI中没有功能(据我所知,Swagger中还没有)可隐藏您所描述的部分描述。建议您使用自己的x-internal-info
字段或可以为适当的受众群体解析的内容。抱歉,这不是您想要的答案!
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。