Gib eine @Document-Klasse von Spring Data MongoDB zusammen mit ihren eingebetteten Klassen und Records ein, und das Tool baut Beispiel-JSON dafür, was ein Controller zurückgibt, wenn er dieses Dokument sendet. Die Form folgt der Standard-Jackson-Serialisierung von Spring Boot, beschreibt also die API-Antwort und nicht das in MongoDB gespeicherte BSON.
Das spart Zeit bei MongoDB-Dokumenten voller eingebetteter Listen, Map-Felder und Instant-Zeitstempel, bei denen ein Antwortbeispiel von Hand mühsam ist, und es macht den Unterschied zwischen Speicherformat und Antwortformat sichtbar.
@Document-Klasse und ihre eingebetteten Klassen oder Records in das Feld Spring Data MongoDB ein.id und Datumswerte durch realistische Werte, bevor du das JSON in Dokus oder Tests verwendest.@Document(collection = "devices")
public class Device {
@Id
private String id;
private String serial;
@Field("fw")
private String firmwareVersion;
private Map<String, Double> lastReadings;
private List<Alert> alerts;
private Instant registeredAt;
}
record Alert(String level, String message, Instant raisedAt) {}{
"id": "",
"serial": "",
"firmwareVersion": "",
"lastReadings": {
"key": 0
},
"alerts": [
{
"level": "",
"message": "",
"raisedAt": "1970-01-01T00:00:00Z"
}
],
"registeredAt": "1970-01-01T00:00:00Z"
}Alert in List<Alert> ist ein Record, daher werden seine Komponenten level, message und raisedAt zu Feldern. Map<String, Double> wird zu {"key": 0}, und Instant ist ein UTC-String mit Z am Ende. @Field("fw") benennt nur das gespeicherte Feld in MongoDB um, der JSON-Key bleibt also firmwareVersion.
record Alert(String level, ...) werden als Felder gelesen.List und Set werden zu Arrays mit einem Element; Map<String, T> wird zu {"key": value}.Instant, ZonedDateTime und OffsetDateTime ergeben 1970-01-01T00:00:00Z, während LocalDateTime einen String ohne Offset ergibt.ObjectId bekommen einen Beispiel-ObjectId-String in Hex.@DBRef verknüpfte Klassen werden zu verschachtelten Objekten, wenn sie Teil der Eingabe sind.@JsonIgnore, @JsonProperty, @JsonIgnoreProperties und geerbte Felder folgen denselben Regeln wie auf der JPA-Seite.Strukturen, die MongoDB in ein Dokument packt, etwa Bewertungslisten, Options-Maps und Verlaufs-Arrays, ergeben lange Antwortbeispiele. Füge die Klassen ein, und jede verschachtelte Ebene wird für dich ausgeschrieben.
Kurznamen über @Field oder auf _id abgebildete Felder sorgen dafür, dass Datenbank-Keys von API-Keys abweichen. Die Ausgabe zeigt die API-Seite, sodass du beide nebeneinanderlegen kannst.
@Field("..."), @Indexed und @TextIndexed ändern keine JSON-Keys und werden nicht abgebildet.@Id String id wird als _id gespeichert, verlässt Jackson aber als id, und genau das zeigt die Ausgabe.org.bson.types.ObjectId als Objekt mit timestamp und date, nicht als Hex-String. Um die hier gezeigte String-Form zu senden, registriere einen ToStringSerializer oder verwende eine String-ID.GeoJsonPoint, werden zu null.@Id vom Typ ObjectId oder String sein?Mit String wandelt Spring Data den Wert beim Speichern in eine ObjectId um, und die API gibt einen sauberen Hex-String zurück. Behältst du den Typ ObjectId, brauchst du für Antworten zusätzliche Jackson-Konfiguration.
@DBRef-Felder wirklich als verschachtelte Objekte zurück?@DBRef löst das referenzierte Dokument beim Lesen auf (bei Lazy Loading beim ersten Zugriff), Antworten enthalten also ein verschachteltes Objekt. Manuelle Referenzen, die nur eine ObjectId- oder String-ID speichern, geben nur die ID zurück.
Map<String, Object>-Feld aus?Sein Werttyp ist unbekannt, daher wird es zu {"key": null}. Ersetze es durch die Art von Wert, die du tatsächlich speicherst, bevor du es in Dokus übernimmst.