大摇大摆编辑器中的多行字符串
如果我在editor.swagger.io中粘贴以下规范:
openapi: 3.0.0
info:
title: Callback Example
version: 1.0.0
paths:
/streams:
post:
description: |
first line
second line
third line
responses:
'201':
description: subscription successfully created
content:
application/json:
schema:
description: subscription information
required:
- subscriptionId
properties:
subscriptionId:
description: this unique identifier allows management of the subscription
type: string
example: 2531329f-fb09-4ef7-887e-84e648214436
描述以单行呈现：
first line second line third line
即使 yaml 规范声明块样式字符串保留换行符：https://yaml-multiline.info/
如何在swagger编辑器中使用多行字符串？
共有2个答案
您可以尝试以下列方式使用br标签:
description: |
First line. <br> Second line.<br> Third line
或者这也行得通:
description: First line. <br> Second line.<br> Third line
您可以使用下面提到的解决方案之一来获得多行招摇。
解决方案1：
description: |
first line \
second line \
third line
解决方案 2：
description: |
first line <br>
second line <br>
third line
-
我有一个java项目（tomcat webapp）和一些REST Api。我想为他们生成大摇大摆的文档。我从本教程（github）开始。我没有maven我们使用蚂蚁任务。我加入了swagger-annotations-1.5.0。jar和所有随swagger jaxrs jar 1.5.0版本附带的jar（如果有用的话，我可以包括一个完整的列表），我已经注释了一些方法，我有一个如下的配置类： }
-
我们在我们的泽西应用程序中使用了@Role允许注释来限制用户对应用编程接口某些部分的访问。我们如何在SwaggerUI中显示这些信息？ 到目前为止，我已经用@ApiOperation注释了方法以显示in/out参数，并尝试使用@Authorization/@AuthorizationScope，但我只为我们不使用的oauth2显示了它。最接近out case的是ApiKeyAuthDefiniti
-
有没有人用spring-data-rest配置了swagger。我知道swagger有DocumentationConfig类，它扫描所有spring-mvc请求映射。但是,如何将其用于spring-data-rest,因为没有定义显式的请求映射。非常感谢在这方面的任何帮助。此外，我还想知道，是否有其他支持Spring-Data-REST的文档框架。
-
理想情况下，我们将有一个显示所有标记为public的控制器/方法的大摇大摆的页面，以及另一个显示所有endpoint的密码安全endpoint。这可能吗？
-
我使用SpringFox库来获取我的Spring Boot应用程序的Rest文档。当我单击模型时，所有元素都作为可选元素返回。有没有办法将必需的元素显示为必需元素？是否需要添加任何其他配置？