如何在Swagger模型描述中使用降价功能?

时间:2016-11-24 12:28:49

标签: swagger swagger-editor

我正在尝试向Swagger中的模型项添加额外信息。文档说GFM语法可以在描述字段中使用,但这并不适用于所有地方。

以下是问题的最小虚拟示例:

BitSet test = new BitSet(10);
for (int i = 0; i < 5; i++) {
    test.set(i, false);
}
System.out.println("len = " + test.length());
System.out.println("size = " + test.size());

Output from Swagger editor

schema object documentation表示我应该可以在标记为上述(4)的地方使用Markdown,但不会对地点(5)做任何说明。

我想将Markdown添加到“模型”部分中的两个位置之一。我怎样才能让它发挥作用?

1 个答案:

答案 0 :(得分:1)

Swagger Editor在模型描述中不支持Markdown。来自https://github.com/swagger-api/swagger-editor/issues/682

  

为了渲染JSON Schema对象,我们使用的是json-schema-view-js lib,它不支持Markdown。 Swagger编辑器无法更改此lib的行为,并且此行为不是添加到lib中的常见行为。

如果您需要此功能,可以分叉swagger-editor和/或json-schema-view-js并自行实施功能/修复,然后提交拉取请求。