Convertissez des classes de documents MongoDB en JSON !

Saisissez des classes de documents MongoDB pour générer un JSON d'exemple ! Compatible avec Spring Data MongoDB @Document. Pratique pour documenter une API et créer des corps de requête de test (mock request body).
Spring Data MongoDB
Résultat
 

Convertissez des classes de documents MongoDB en JSON !

Donnez-lui une classe @Document Spring Data MongoDB avec ses classes et records embarqués, et il construit un JSON d'exemple de ce que renvoie un contrôleur quand il envoie ce document. La forme suit la sérialisation Jackson par défaut de Spring Boot : elle décrit la réponse de l'API, pas le BSON stocké dans MongoDB.

Cela fait gagner du temps sur les documents MongoDB remplis de listes embarquées, de champs Map et d'horodatages Instant, pour lesquels écrire un exemple de réponse à la main est fastidieux, et cela rend visible l'écart entre le format de stockage et le format de réponse.

Mode d'emploi

  1. Collez la classe @Document et ses classes ou records embarqués dans le champ Spring Data MongoDB.
  2. La classe de document qu'aucune autre ne référence devient la racine de la sortie.
  3. Remplacez les valeurs génériques d'id et de date par des valeurs réalistes avant d'utiliser le JSON dans une doc ou des tests.

Exemple

Entrée (Java · Spring Data MongoDB)
@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) {}
Sortie (JSON)
{
  "id": "",
  "serial": "",
  "firmwareVersion": "",
  "lastReadings": {
    "key": 0
  },
  "alerts": [
    {
      "level": "",
      "message": "",
      "raisedAt": "1970-01-01T00:00:00Z"
    }
  ],
  "registeredAt": "1970-01-01T00:00:00Z"
}

Alert dans List<Alert> est un record : ses composants level, message et raisedAt deviennent donc des champs. Map<String, Double> devient {"key": 0}, et Instant est une chaîne UTC terminée par Z. @Field("fw") ne renomme que le champ stocké dans MongoDB : la clé JSON reste firmwareVersion.

Fonctionnalités prises en charge

  • Les composants de record Java, comme dans record Alert(String level, ...), sont lus comme des champs.
  • List et Set deviennent des tableaux d'un élément ; Map<String, T> devient {"key": value}.
  • Instant, ZonedDateTime et OffsetDateTime donnent 1970-01-01T00:00:00Z, tandis que LocalDateTime donne une chaîne sans décalage.
  • Les champs typés ObjectId reçoivent une chaîne ObjectId hexadécimale d'exemple.
  • Les classes liées par @DBRef deviennent des objets imbriqués quand elles font partie de l'entrée.
  • @JsonIgnore, @JsonProperty, @JsonIgnoreProperties et les champs hérités suivent les mêmes règles que sur la page JPA.

Cas d'utilisation

Réponses avec de nombreux documents embarqués

Les structures que MongoDB regroupe dans un seul document, comme des listes d'avis, des maps d'options et des tableaux d'historique, donnent de longs exemples de réponse. Collez les classes et chaque niveau imbriqué est écrit pour vous.

Comparer forme stockée et forme renvoyée

Les noms courts via @Field ou les champs mappés sur _id font différer les clés en base des clés de l'API. La sortie montre le côté API : vous pouvez mettre les deux côte à côte.

Remarques et limites

  • Les annotations de mapping comme @Field("..."), @Indexed et @TextIndexed ne changent pas les clés JSON et ne sont pas reflétées.
  • @Id String id est stocké en _id mais sort de Jackson sous le nom id, ce que montre la sortie.
  • Le Jackson par défaut de Spring Boot écrit org.bson.types.ObjectId comme un objet avec timestamp et date, pas comme une chaîne hexadécimale. Pour envoyer la forme chaîne affichée ici, enregistrez un ToStringSerializer ou utilisez un id String.
  • Les classes absentes de l'entrée, y compris les types Spring Data comme GeoJsonPoint, deviennent null.

FAQ

Mon @Id doit-il être ObjectId ou String ?

Avec String, Spring Data le convertit en ObjectId à l'enregistrement et l'API renvoie une chaîne hexadécimale propre. Garder le type ObjectId impose une configuration Jackson supplémentaire pour les réponses.

Les champs @DBRef reviennent-ils vraiment sous forme d'objets imbriqués ?

@DBRef résout le document référencé à la lecture (au premier accès s'il est lazy) : les réponses contiennent donc un objet imbriqué. Les références manuelles qui ne stockent qu'un id ObjectId ou String ne renvoient que l'id.

À quoi ressemble un champ Map<String, Object> libre ?

Son type de valeur est inconnu : il devient donc {"key": null}. Remplacez-le par le type de valeur que vous stockez réellement avant de le mettre dans une doc.