Unterschiede zwischen Api und Modell Swagger

Question

Ich bin neu mit Swagger und ich definiere eine API.

Kann ich eine API mit Swagger definieren, ohne die @ApiModelProperty Annotation verwenden zu müssen? Was genau ist ein Objektmodell in Swagger?

Answer 1

Ja, Sie können eine API definieren, ohne die @ApiModelProperty zu verwenden. Das Modellobjekt ist kein erforderliches Feld in der OpenAPI-Spezifikation.

Das Modellobjekt enthält ein Feld pro Modelldefinition, das sich von der Struktur der anderen Objekte in der Spezifikation unterscheidet. Es folgt eine Teilmenge der JSON-Schema-Spezifikation.

@ApiModelProperty definiert die Eigenschaften dieses Objekts. Auch Model Object ist ein Teil der Antwort in Swagger

Beispiel Sie haben ein Modell - User Klasse.

class User { 
    int id; 
    String name; 
    int age; 
} 

Modell Objekt enthält Informationen über Benutzer.

{ 
"User": { 
    "id": "User", 
    "properties": { 
    "id": { 
     "type": "integer", 
     "format": "int64" 
    }, 
    "name": { 
     "type": "string" 
    }, 
    "age": { 
     "type": "integer" 
    } 
    } 
} 
} 

@ApiModelProperty wird in der Java-Klasse verwendet User dieses JSON zu erzeugen, indem die Definition-ID, Name und Alter in seinem Inneren.