Aprender conceptos para el Atlas Go SDK

Introducción

Puede usar el SDK de Atlas Go para obtener o modificar datos de la API de administración de Atlas. El SDK de Atlas Go es flexible porque acepta diversos tipos de argumentos.

Obteniendo datos desde la parte posterior

Para obtener datos, puede ejecutar el {Api}.{Operation}WithParams() :

// Surrounding code omitted for brevity
// 1. Calling API method
request := sdk.ProjectsApi.ListProjectsWithParams(ctx,
    // 2. Passing a struct with all optional query parameters to the request
    &admin.ListProjectsApiParams{
        ItemsPerPage: admin.PtrInt(1),
        IncludeCount: admin.PtrBool(true),
        PageNum:      admin.PtrInt(1),
    })
// 3. You can also supply values in requests using individual methods
// This can be helpful when passing request objects to other methods.
projects, response, err := request.ItemsPerPage(10).Execute()
examples.HandleErr(err, response)

Alternativamente, puede utilizar el método {Operation}() más corto con un patrón de generador para proporcionar todos los argumentos:

// Surrounding code omitted for brevity
projects, response, err := sdk.ProjectsApi.ListProjects(ctx).ItemsPerPage(1).Execute()

Nota: El SDK Atlas Go requiere parámetros de ruta y deben proporcionarse directamente en el método {Operation}().

Nota: El SDK Atlas Go proporciona valores predeterminados para los objetos de consulta y publicación.

Realizar modificación de datos

Utilice el método {Operation}() para realizar modificaciones. Por ejemplo:

// Surrounding code omitted for brevity
groupInvitationRequest := admin.NewGroupInvitationRequest()
resp, r, err := sdk.ProjectsApi.CreateProjectInvitation(context.Background(), groupId, groupInvitationRequest).Execute()

Campos de solo lectura y solo escritura

Cada solicitud y respuesta del SDK puede contener campos de solo lectura o de solo escritura, según lo identificado por el documentación y los comentarios de Go doc.

Usamos comentarios de GoDoc para anotar campos como solo de lectura y escritura:

• // Read Only field. significa que el campo está incluido en las respuestas pero no en las solicitudes

• // Write Only field. significa que el campo puede incluirse en las solicitudes pero no en las respuestas

Ejemplo

Para obtener más información sobre cómo usar el SDK, consulta el ejemplo básico.

Estrategia de lanzamiento (versiones semánticas)

El SDK de Atlas Go sigue la especificación de Versionado Semántico (SemVer). El esquema de versiones utilizado para este SDK es el siguiente: vYYYYMMDDXXX.Y.Z , donde:

• YYYYMMDDXXX Representa el número de versión principal. Incluye la fecha de la versión del recurso API versionado que utiliza el SDK, seguida de tres dígitos para otros posibles cambios importantes.

• Y representa el número de versión menor, lo que indica iteraciones ininterrumpidas del mismo recurso de API versionado.

• Z Representa el número de versión del parche, que indica correcciones en el SDK que no afectan a los usuarios.

Versión de ejemplo: v20230201001.0.0

Analicemos la versión de ejemplo v20230201001.0.0 para comprender sus componentes:

• Versión principal: v20230201001.0.0

  • v : Indica el inicio del número de versión.

  • 20230201 :La fecha de la versión de API versionada que utiliza este SDK, en el formato YYYYMMDD.

  • 001 comienza desde 001 y aumenta en 1 por cada iteración no retrocompatible que apunte a la versión específica del recurso de la API.

La versión v20230201001.0.0 representa el lanzamiento inicial de la biblioteca SDK de Golang para la API versionada con fecha del 1 ​​de febrero de 2023, sin otros cambios importantes, iteraciones o correcciones.