Passe uma classe @Document do Spring Data MongoDB junto com as suas classes e records embutidos, e ele monta um JSON de exemplo do que um controller retorna ao mandar esse documento. O formato segue a serialização padrão do Jackson no Spring Boot, então descreve a resposta da API, não o BSON guardado no MongoDB.
Economiza tempo com documentos MongoDB cheios de listas embutidas, campos Map e timestamps Instant, em que escrever um exemplo de resposta à mão é cansativo, e deixa visível a diferença entre o formato de armazenamento e o formato da resposta.
@Document e as suas classes ou records embutidos na caixa Spring Data MongoDB.id e de data por valores realistas antes de usar o JSON em documentação ou testes.@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 em List<Alert> é um record, então os componentes level, message e raisedAt viram campos. Map<String, Double> vira {"key": 0}, e Instant é uma string UTC terminando em Z. @Field("fw") só renomeia o campo armazenado no MongoDB, então a chave JSON continua firmwareVersion.
record Alert(String level, ...), são lidos como campos.List e Set viram arrays de um elemento; Map<String, T> vira {"key": value}.Instant, ZonedDateTime e OffsetDateTime dão 1970-01-01T00:00:00Z, enquanto LocalDateTime dá uma string sem offset.ObjectId recebem uma string ObjectId hexadecimal de exemplo.@DBRef viram objetos aninhados quando fazem parte da entrada.@JsonIgnore, @JsonProperty, @JsonIgnoreProperties e campos herdados seguem as mesmas regras da página JPA.Estruturas que o MongoDB empacota num documento só, como listas de reviews, maps de opções e arrays de histórico, rendem exemplos de resposta longos. Cole as classes e cada nível aninhado é escrito para você.
Nomes curtos via @Field ou campos mapeados para _id fazem as chaves do banco diferirem das chaves da API. A saída mostra o lado da API, para você colocar os dois lado a lado.
@Field("..."), @Indexed e @TextIndexed não mudam as chaves JSON e não são refletidas.@Id String id é guardado como _id, mas sai do Jackson como id, que é o que a saída mostra.org.bson.types.ObjectId como um objeto com timestamp e date, não como string hexadecimal. Para mandar a forma string mostrada aqui, registre um ToStringSerializer ou use um id String.GeoJsonPoint, viram null.@Id deve ser ObjectId ou String?Com String, o Spring Data o converte em ObjectId ao salvar e a API devolve uma string hexadecimal limpa. Manter o tipo ObjectId significa que você precisa de configuração extra do Jackson para as respostas.
@DBRef voltam mesmo como objetos aninhados?O @DBRef resolve o documento referenciado na leitura (no primeiro acesso, se for lazy), então as respostas contêm um objeto aninhado. Referências manuais que só guardam um id ObjectId ou String devolvem apenas o id.
Map<String, Object>?O tipo do valor é desconhecido, então ele vira {"key": null}. Troque pelo tipo de valor que você realmente guarda antes de colocar na documentação.