SpringFox大摇大摆-可选的,必填字段

Question

我使用SpringFox库来获取我的Spring Boot应用程序的Rest文档。当我单击模型时，所有元素都作为可选元素返回。有没有办法将必需的元素显示为必需元素？是否需要添加任何其他配置？

Answer 1

在Swagger配置中尝试类似的代码:

    @Bean
public Docket api() {

    List<ResponseMessage> list = new java.util.ArrayList<>();
    list.add(new ResponseMessageBuilder().code(500).message("500 message")
            .responseModel(new ModelRef("JSONResult«string»")).build());
    list.add(new ResponseMessageBuilder().code(401).message("Unauthorized")
            .responseModel(new ModelRef("JSONResult«string»")).build());

    return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any()).build().securitySchemes(Collections.singletonList(securitySchema()))
            .securityContexts(Collections.singletonList(securityContext())).pathMapping("/")
            .directModelSubstitute(LocalDate.class, String.class).genericModelSubstitutes(ResponseEntity.class)
            .alternateTypeRules(newRule(
                    typeResolver.resolve(DeferredResult.class,
                    typeResolver.resolve(ResponseEntity.class, WildcardType.class)),
                    typeResolver.resolve(WildcardType.class)))
            .useDefaultResponseMessages(false).apiInfo(apiInfo()).globalResponseMessage(RequestMethod.GET, list)
            .globalResponseMessage(RequestMethod.POST, list);
}

在控制器映射中添加< code > @ request body @ Valid MyRequestClass req 例如，如果您在请求体中传递对象，如果您传递参数，则添加类似于< code > @ request param(value = " email "，required = true，defaultValue = " ")字符串email的内容

此外，请参见配置代码中如何引用具有一般类型的类，即引用< code>JSONResult的< code >“JSON result string”

Answer 2

在Springfox v2.3.2中增加了对bean验证注释的支持，特别是对@NotNull、@Min、@Max和@Size的支持。

您可以将这些注释放在任何API模型上。

为了使用它，添加springfox bean validators依赖项：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-bean-validators</artifactId>
</dependency>

添加到应用程序的配置类：

java prettyprint-override">@Import({springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration.class})

见:https://spring fox . github . io/spring fox/docs/current/# spring fox-support-for-JSR-303

Answer 3

是。默认情况下，所有字段都是可选的。要根据需要标记字段，可以使用以下注释。

@ApiModelProperty(required = true)

关于应要求的场的吸气剂方法。这不会将字段显示为“强制”。但文档中此字段的可选标记将被删除。

希望这有帮助。