大摇大摆的帖子需要六个字段中的两个[副本]
我试图写一个大摇大摆的文档，其中五个字段中的两个字段是在一个POST请求中必需的。我读过一些关于如何做到这一点的选择，但似乎找不到一个明确的答案。
/my-endpoint:
post:
x-swagger-router-controller: example.spec
operationId: example_operationId
parameters:
- in: body
name: recovery_data
description: TODO
schema:
$ref: '#/definitions/RecoveryData'
required: true
responses:
200:
description: TODO
schema:
$ref: '#/definitions/OkResponse'
RecoveryData:
type: object
properties:
required_field_1:
description: TODO
type: array
required: true
required_field_2:
description: TODO
type: string
required: true
optional_field_1:
description: TODO
type: boolean
required: false
optional_field_2:
description: TODO
type: boolean
required: false
optional_field_3:
description: TODO
type: boolean
required: false
optional_field_4:
description: TODO
type: string
required: false
/my-endpoint:
post:
x-swagger-router-controller: example.spec
operationId: example_operationId
parameters:
- in: body
name: recovery_data
description: TODO
schema:
$ref: '#/definitions/RecoveryData'
responses:
200:
description: TODO
schema:
$ref: '#/definitions/OkResponse'
RecoveryData:
type: object
properties:
required_field_1:
description: TODO
type: array
required: true
required_field_2:
description: TODO
type: string
required: true
optional_field_1:
description: TODO
type: boolean
optional_field_2:
description: TODO
type: boolean
optional_field_3:
description: TODO
type: boolean
optional_field_4:
description: TODO
type: string
共有1个答案
这与如何指定字段在Swagger中是可选的还是必需的问题有点重复？
答案似乎是：
RecoveryData:
type: object
required:
- required_field_1
- required_field_2
properties:
required_field_1:
description: TODO
type: array
required_field_2:
description: TODO
type: string
optional_field_1:
description: TODO
type: boolean
optional_field_2:
description: TODO
type: boolean
optional_field_3:
description: TODO
type: boolean
optional_field_4:
description: TODO
type: string
-
它没有任何问题，没有抛出异常或任何其他迹象。为什么？
-
我们在我们的泽西应用程序中使用了@Role允许注释来限制用户对应用编程接口某些部分的访问。我们如何在SwaggerUI中显示这些信息？ 到目前为止，我已经用@ApiOperation注释了方法以显示in/out参数，并尝试使用@Authorization/@AuthorizationScope，但我只为我们不使用的oauth2显示了它。最接近out case的是ApiKeyAuthDefiniti
-
我想大摇大摆地发布一个json正文，就像这样: 目前，我有这样的定义： 但是数据是在URL中发送的。这里是Swagger提供的生成的curl： 我知道＜code＞查询＜/code＞关键字不好，但我没有找到POST JSON正文的方法。我尝试了＜code＞formData＜/code＞，但没有成功。
-
我正在尝试验证swagger文件（实际上是我的gradle构建的一部分）。我曾经尝试过使用swagger解析器，但尽管它可以工作，如果swagger根本不进行解析，就会出现错误，但它似乎无法以这种方式捕获问题http://editor.swagger.io/#/做（这就是我要找的。） 当然，这是一个很常见的问题，一定有办法做到这一点？ 我所尝试的： build.gradle： 有一些明显问题的简单
-
我使用SpringFox库来获取我的Spring Boot应用程序的Rest文档。当我单击模型时，所有元素都作为可选元素返回。有没有办法将必需的元素显示为必需元素？是否需要添加任何其他配置？
-
有没有人用spring-data-rest配置了swagger。我知道swagger有DocumentationConfig类，它扫描所有spring-mvc请求映射。但是,如何将其用于spring-data-rest,因为没有定义显式的请求映射。非常感谢在这方面的任何帮助。此外，我还想知道，是否有其他支持Spring-Data-REST的文档框架。