Подайте класс @Document из Spring Data MongoDB вместе с его встроенными классами и records — и он построит пример JSON того, что возвращает контроллер, отдавая этот документ. Форма следует стандартной сериализации Jackson в Spring Boot, так что описывает ответ API, а не BSON, хранящийся в MongoDB.
Экономит время на документах MongoDB, полных встроенных списков, полей Map и меток времени Instant, где писать пример ответа вручную утомительно, и делает видимым разрыв между форматом хранения и форматом ответа.
@Document и его встроенные классы или records в поле Spring Data MongoDB.id и дат реалистичными значениями.@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 в List<Alert> — это record, поэтому его компоненты level, message и raisedAt становятся полями. Map<String, Double> превращается в {"key": 0}, а Instant — в UTC-строку с Z на конце. @Field("fw") переименовывает только хранимое поле в MongoDB, поэтому ключ JSON остаётся firmwareVersion.
record Alert(String level, ...), читаются как поля.List и Set становятся массивами из одного элемента; Map<String, T> — {"key": value}.Instant, ZonedDateTime и OffsetDateTime дают 1970-01-01T00:00:00Z, а LocalDateTime — строку без смещения.ObjectId получают строку-пример ObjectId в hex.@DBRef, становятся вложенными объектами, если они есть во вводе.@JsonIgnore, @JsonProperty, @JsonIgnoreProperties и унаследованные поля подчиняются тем же правилам, что и на JPA-странице.Структуры, которые MongoDB упаковывает в один документ, — списки отзывов, карты опций, массивы истории — дают длинные примеры ответов. Вставьте классы, и каждый вложенный уровень будет расписан за вас.
Короткие имена через @Field или поля, отображённые на _id, делают ключи в базе отличными от ключей API. Вывод показывает сторону API, так что их можно положить рядом.
@Field("..."), @Indexed и @TextIndexed, не меняют ключи JSON и не отражаются.@Id String id хранится как _id, но из Jackson выходит как id — это и показывает вывод.org.bson.types.ObjectId как объект с timestamp и date, а не как hex-строку. Чтобы отдавать строковую форму, показанную здесь, зарегистрируйте ToStringSerializer или используйте id типа String.GeoJsonPoint, становятся null.@Id — ObjectId или String?С String Spring Data преобразует его в ObjectId при сохранении, а API возвращает чистую hex-строку. Если оставить тип ObjectId, для ответов потребуется дополнительная настройка Jackson.
@DBRef возвращаются вложенными объектами?@DBRef разрешает ссылочный документ при чтении (при первом обращении, если он ленивый), так что ответы содержат вложенный объект. Ручные ссылки, хранящие только id типа ObjectId или String, возвращают лишь id.
Map<String, Object>?Тип его значений неизвестен, поэтому оно становится {"key": null}. Прежде чем помещать его в документацию, замените на значения того вида, который вы реально храните.