Stable API

Overview

En esta guía, puedes aprender a especificar la compatibilidad de la API estable al conectarse a una implementación de MongoDB.

La funcionalidad de Stable API obliga al servidor a ejecutar operaciones con comportamientos compatibles con la versión de API que especifique. El uso de la Stable API garantiza respuestas coherentes del servidor y proporciona una estabilidad a largo plazo de la API para tu aplicación.

Las siguientes secciones describen cómo puedes habilitar y personalizar Stable API para tu cliente de MongoDB. Para obtener más información sobre la Stable API, incluyendo una lista de los comandos que soporta, consulta Stable API en el manual del MongoDB Server.

Activar la API estable

Para habilitar la API Stable, realiza los siguientes pasos:

1. Construye un objeto ServerApi y especifica una versión de Stable API. Se debe utilizar una versión de API estable definida en el enum ServerApiVersion.

2. Cree un objeto MongoClientSettings utilizando la clase MongoClientSettings.Builder.

3. Instancia un MongoClient usando el método MongoClients.create() y pasa tu instancia MongoClientSettings como parámetro.

El siguiente ejemplo de código muestra cómo especificar la versión Stable API 1:

ServerApi serverApi = ServerApi.builder()
        .version(ServerApiVersion.V1)
        .build();
// Replace the placeholder with your Atlas connection string
String uri = "<connection string URI>";
MongoClientSettings settings = MongoClientSettings.builder()
        .applyConnectionString(new ConnectionString(uri))
        .serverApi(serverApi)
        .build();
try (MongoClient mongoClient = MongoClients.create(settings)) {
    // Perform client operations here
}

Una vez que crees una instancia de MongoClient con la Stable API, todos los comandos que ejecutes con el cliente utilizan la configuración de la Stable API especificada. Si debe ejecutar comandos utilizando configuraciones alternativas, cree un nuevo MongoClient.

Configura la Stable API

La siguiente tabla describe los métodos encadenables de la clase ServerApi.Builder que puedes usar para personalizar el comportamiento de la Stable API.

El siguiente ejemplo de código muestra cómo puedes configurar una instancia de ServerApi encadenando métodos en el ServerApi.Builder:

ServerApi serverApi = ServerApi.builder()
    .version(ServerApiVersion.V1)
    .strict(true)
    .deprecationErrors(true)
    .build();

Solución de problemas

Documentación de la API

Para obtener más información sobre cómo utilizar la Stable API con el controlador de Java Reactive Streams, consulte la siguiente documentación de la API:

• ServerApi

• ServerApi.Builder

• ServerApiVersion

• DirecciónDelServidor

• MongoClientSettings

• MongoClientSettings.Builder

• MongoClients