SpringFox Swagger - Optionale und obligatorische Felder in Modell

Question

Ich habe SpringFox-Bibliothek für Ruhe Dokumentation meiner Spring-Boot-App verwendet. Wenn ich auf Modell klicke, werden alle Elemente als optional zurückgegeben. Gibt es eine Möglichkeit, erforderliche Elemente als obligatorisch anzuzeigen? Gibt es eine zusätzliche Konfiguration, die hinzugefügt werden muss?

Answer 1

Ja standardmäßig Alle th Die Felder sind optional. Um ein Feld nach Bedarf zu markieren, können Sie folgende Anmerkung verwenden.

@ApiModelProperty(required = true) 

Auf die Getter-Methode des Feldes, das erforderlich sein sollte. Dies zeigt das Feld nicht als "obligatorisch" an. Aber das optionale Tag wird für dieses Feld in der Dokumentation entfernt.

Hoffe, das hilft.

Answer 2

Versuchen Sie, die einen ähnlichen Code in Swagger Konfiguration:

@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); 
} 

Und in der Controller-Mapping @RequestBody @Valid MyRequestClass req beispielsweise hinzufügen, wenn Sie Objekte in der Anfrage Körper sind vorbei, und wenn Sie Gabe von Parametern hinzufügen etwas wie @RequestParam(value = "email", required = true, defaultValue = "") String email

siehe

auch, wie in dem Config-Code, wie eine Klasse mit generischem Typ verweisen, dh "JSONResult«string»" die verweisen JSONResult<String>