当前位置: 首页 > 知识库问答 >
问题:

大摇大摆从Mustache访问查询参数属性

邬友樵
2023-03-14

我使用Mustach和swagger codegen从定义生成模型实体,从操作生成代码(路径部分)。每个操作都指定一个参数列表和其他参数属性-数据类型、描述、默认值、必需、最大值、示例等。

除了'required'属性外,我无法确定如何访问任何参数属性。。。除了“模型”阶段。。。如何在“api”阶段做到这一点。。。我希望能够删除验证参数是否满足“必需”条件的代码,如min/max等。

共有1个答案

凌翔宇
2023-03-14

您有一些访问参数属性的选项。

首先,我假设您使用的是swagger-codemen 2.1.0-M2或更高版本的快照。每个参数都有许多可用的属性,但目前它们不如模型属性丰富。

要查看您有权访问的内容,请运行带有调试标志的codegen,它将打印出模板中的所有可用信息:

java -DdebugOperations -jar swagger-codegen-cli.jar \
      generate \
     -i http://petstore.swagger.io/v2/swagger.json \
     -l java \
     -o samples/client/petstore/java

其他调试标志是:

# print out the interpreted swagger spec
-DdebugSwagger

# print out model info
-DdebugModels

# print out supporting file data
-DdebugSupportingFiles
 类似资料:
  • 我有这个控制器和操作方法: 下面是模型: 我需要使用<code>Location</code>作为URL中的查询参数名称,以便按预期到达endpoint。 例如< code > http://localhost/API/Appointment/Company/available slots?位置=SYD 然而,当我查看Swagger页面时,该参数被称为<code>Model。位置,这让我的API的

  • 我有一个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

  • thoses线有什么问题 “data”属性应该是$ref中给出的模式类型的数组,但这是结果 好的,似乎正确的方法是tu把$ref直接放在items键下,我的问题是使用保留键“status”,那么,我如何在对象模式中使用保留键呢? 在我的客户机模式中,我将属性status放了两次,但我没有看到它已经存在,所以当我更改属性名时,它起作用了,我在想“status”可能是一个保留的关键字。

  • 有没有人用spring-data-rest配置了swagger。我知道swagger有DocumentationConfig类,它扫描所有spring-mvc请求映射。但是,如何将其用于spring-data-rest,因为没有定义显式的请求映射。非常感谢在这方面的任何帮助。此外,我还想知道,是否有其他支持Spring-Data-REST的文档框架。