Aprender conceptos para el Atlas Go SDK

Introducción

Puede utilizar el SDK Atlas Go para obtener o modificar datos de la API Admin de Atlas. El Atlas Go SDK es flexible porque acepta muchos tipos diferentes de argumentos.

Obteniendo datos desde la parte posterior

Para buscar datos, puedes ejecutar el método {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 construcción 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 Atlas Go SDK suministra valores por defecto tanto para los objetos de query como para los objetos de publicación.

Modificação de Dados

Utiliza 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()

Read Only and Solo guardar Fields

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

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

• // Read Only field. significa que el campo se incluye 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 (versionamiento semántico)

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 la versión principal. Incluye la fecha de la Versión de Recurso API Versionado que utiliza el SDK, seguida de tres dígitos para otros posibles cambios disruptivos.

• Y representa el número de versión secundaria, que indica iteraciones compatibles de la misma Recurso 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 la API versionada que este SDK está usando, en el formato de 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 version v20230201001.0.0 representa el lanzamiento inicial de la librería SDK golang para la API versionada fechada en febrero 1, 2023, sin otros cambios disruptivos, iteraciones o correcciones.