Aprenda conceitos do SDK do Atlas Go

Introdução

Você pode usar o SDK do Atlas Go para buscar ou modificar dados da API de administrador do Atlas . O Atlas Go SDK é flexível porque aceita muitos tipos diferentes de argumentos.

Buscando dados do back-end

Para buscar dados, você pode executar o 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, você pode utilizar o método {Operation}() mais curto com um padrão de construtor para fornecer todos os argumentos:

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

Observação: o Atlas Go SDK exige parâmetros de caminho e eles devem ser fornecidos diretamente no método {Operation}() .

Observação: O Atlas Go SDK fornece valores padrão para objetos de query e postagem.

Executando modificação de dados

Use o método {Operation}() para executar modificações. Por exemplo:

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

Campos Somente Leitura e Somente Escrita

Cada solicitação e resposta do SDK pode conter campos somente leitura ou somente gravação, conforme identificado pela documentação e pelos comentários do documento Go.

Usamos comentários do GoDoc para anotar campos como somente leitura e gravação:

• // Read Only field. significa que o campo está incluído nas respostas, mas não nas solicitações

• // Write Only field. significa que o campo pode ser incluído em solicitações, mas não em respostas

Exemplo

Para saber mais sobre como usar o SDK, consulte o exemplo básico .

Estratégia de lançamento (versão semântica)

O Atlas Go SDK segue a especificação Semantic Versioning (SemVer). O esquema de controle de versão usado para esse SDK é o seguinte: vYYYYMMDDXXX.Y.Z , onde:

• YYYYMMDDXXX representa o número da versão principal. Ela inclui a data da versão do recurso da API versionada que o SDK usa, seguida de três dígitos para outras possíveis alterações significativas.

• Y representa o número da versão secundária, indicando iterações não separáveis do mesmo Recurso de API Versionado.

• Z representa o número da versão do patch, indicando correções no SDK que não afetam os usuários.

Versão do exemplo: v20230201001.0.0

Vamos detalhar o exemplo da versão v20230201001.0.0 para entender seus componentes:

• Versão principal: v20230201001.0.0

  • v : Indica o início do número da versão.

  • 20230201 : a data da versão da API versionada que este SDK está usando, no formato de YYYYMMDD.

  • 001 começa do 001 e é incrementado pelo 1 para cada iteração não compatível com versões anteriores destinada à versão específica do recurso da API.

A versão v20230201001.0.0 representa a versão inicial da biblioteca Go SDK para a API versionada datada de 1 de fevereiro de 2023, sem outras alterações, iterações ou correções significativas.