¡Convierte clases de documentos de MongoDB en JSON!

¡Introduce clases de documentos de MongoDB para generar JSON de ejemplo! Compatible con Spring Data MongoDB @Document. Útil para documentar APIs y cuerpos de petición de prueba (mock request body).
Spring Data MongoDB
Resultado
 

¡Convierte clases de documentos de MongoDB en JSON!

Pásale una clase @Document de Spring Data MongoDB junto con sus clases y records embebidos, y construye un JSON de ejemplo de lo que devuelve un controller cuando envía ese documento. La forma sigue la serialización de Jackson por defecto de Spring Boot, así que describe la respuesta de la API, no el BSON almacenado en MongoDB.

Ahorra tiempo con documentos de MongoDB llenos de listas embebidas, campos Map y timestamps Instant, donde escribir a mano un ejemplo de respuesta es tedioso, y hace visible la diferencia entre el formato de almacenamiento y el de respuesta.

Cómo usar

  1. Pega la clase @Document y sus clases o records embebidos en el cuadro Spring Data MongoDB.
  2. La clase de documento que ninguna otra clase referencia pasa a ser la raíz de la salida.
  3. Sustituye los placeholders de id y de fechas por valores realistas antes de usar el JSON en documentación o tests.

Ejemplo

Entrada (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) {}
Salida (JSON)
{
  "id": "",
  "serial": "",
  "firmwareVersion": "",
  "lastReadings": {
    "key": 0
  },
  "alerts": [
    {
      "level": "",
      "message": "",
      "raisedAt": "1970-01-01T00:00:00Z"
    }
  ],
  "registeredAt": "1970-01-01T00:00:00Z"
}

Alert en List<Alert> es un record, así que sus componentes level, message y raisedAt pasan a ser campos. Map<String, Double> pasa a {"key": 0}, e Instant es una cadena UTC terminada en Z. @Field("fw") solo renombra el campo almacenado en MongoDB, así que la clave JSON sigue siendo firmwareVersion.

Funciones compatibles

  • Los componentes de los records de Java, como en record Alert(String level, ...), se leen como campos.
  • List y Set pasan a arrays de un elemento; Map<String, T> pasa a {"key": value}.
  • Instant, ZonedDateTime y OffsetDateTime dan 1970-01-01T00:00:00Z, mientras que LocalDateTime da una cadena sin offset.
  • Los campos de tipo ObjectId reciben una cadena ObjectId hexadecimal de ejemplo.
  • Las clases enlazadas con @DBRef pasan a objetos anidados cuando forman parte de la entrada.
  • @JsonIgnore, @JsonProperty, @JsonIgnoreProperties y los campos heredados siguen las mismas reglas que en la página de JPA.

Casos de uso

Respuestas con muchos documentos embebidos

Las estructuras que MongoDB agrupa en un solo documento, como listas de reseñas, maps de opciones y arrays de historial, dan ejemplos de respuesta largos. Pega las clases y todos los niveles anidados se escriben por ti.

Comparar la forma almacenada y la devuelta

Los nombres cortos mediante @Field o los campos mapeados a _id hacen que las claves de la base de datos difieran de las de la API. La salida muestra el lado de la API, así que puedes poner ambas una junto a otra.

Notas y limitaciones

  • Las anotaciones de mapeo como @Field("..."), @Indexed y @TextIndexed no cambian las claves JSON y no se reflejan.
  • @Id String id se guarda como _id pero sale de Jackson como id, que es lo que muestra la salida.
  • El Jackson por defecto de Spring Boot escribe org.bson.types.ObjectId como un objeto con timestamp y date, no como cadena hexadecimal. Para enviar la forma de cadena que se muestra aquí, registra un ToStringSerializer o usa un id String.
  • Las clases que faltan en la entrada, incluidos tipos de Spring Data como GeoJsonPoint, pasan a null.

Preguntas frecuentes

¿Mi @Id debería ser ObjectId o String?

Con String, Spring Data lo convierte en ObjectId al guardar y la API devuelve una cadena hexadecimal limpia. Mantener el tipo ObjectId implica configuración extra de Jackson para las respuestas.

¿Los campos @DBRef vuelven de verdad como objetos anidados?

@DBRef resuelve el documento referenciado al leer (en el primer acceso si es lazy), así que las respuestas contienen un objeto anidado. Las referencias manuales que guardan solo un id ObjectId o String devuelven solo el id.

¿Cómo se ve un campo Map<String, Object> de forma libre?

Su tipo de valor es desconocido, así que pasa a {"key": null}. Sustitúyelo por el tipo de valor que realmente guardas antes de llevarlo a la documentación.