Atlas Go SDK 개념 알아보기

서론

Atlas 고 (Go) SDK를 사용하여 Atlas Admin API 에서 데이터를 가져오거나 수정할 수 있습니다. Atlas 고 (Go) SDK는 다양한 유형의 인수를 허용하므로 유연합니다.

백엔드에서 데이터 가져오기

데이터를 가져오려면 {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)

또는 빌더 패턴 과 함께 더 짧은 {Operation}() 메서드를 사용하여 모든 인수를 제공할 수 있습니다.

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

참고: Atlas 고 (Go) SDK에는 경로 매개 변수가 필요하며 {Operation}() 메서드에서 직접 제공해야 합니다.

참고: Atlas 고 (Go) SDK는 쿼리 및 게시 객체 모두에 대한 기본값 을 제공합니다.

데이터 수정 수행

{Operation}() 메서드를 사용하여 수정합니다. 예를 예시 다음과 같습니다.

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

읽기 전용 및 쓰기 전용 필드

각 SDK 요청 및 응답에는 설명서와 Go Docs 댓글에 명시된 대로 읽기 전용 또는 쓰기 전용 필드가 포함될 수 있습니다.

GoDoc 주석을 사용하여 필드에 읽기 및 쓰기 (write) 전용으로 주석을 달 수 있습니다.

• // Read Only field. 는 필드 가 응답에는 포함되지만 요청에는 포함되지 않음을 의미합니다.

• // Write Only field. 는 필드 가 요청에는 포함될 수 있지만 응답에는 포함될 수 없음을 의미합니다.

예시

SDK 사용에 학습 보려면 기본 예시 를 참조하세요.

릴리스 전략(의미론적 버전 관리)

Atlas 고 (Go) SDK는 시맨틱 버전 관리(SemVer) 사양을 따릅니다. 이 SDK에 사용되는 버전 관리 체계는 다음과 같습니다: vYYYYMMDDXXX.Y.Z , 여기서:

• YYYYMMDDXXX 는 주요 버전 번호를 나타냅니다. 여기에는 SDK가 사용하는 버전이 지정된 API 리소스 버전 의 날짜와 기타 가능한 호환성이 손상되는 변경을 위한 세 자리 숫자가 포함됩니다.

• Y 동일한 버전이 지정된 API 리소스의 호환성이 손상되지 않는 반복을 나타내는 마이너 버전 번호를 나타냅니다.

• Z 은(는) 사용자에게 영향을 주지 않는 SDK의 수정 사항을 나타내는 패치 버전 번호를 나타냅니다.

예제 버전: v20230201001.0.0

구성 요소를 이해하기 위해 예시 버전 v20230201001.0.0 을 분석해 보겠습니다.

• 주요 버전: v20230201001.0.0

  • v : 버전 번호의 시작을 나타냅니다.

  • 20230201 : 이 SDK가 사용 중인 버전이 지정된 API 버전의 날짜( YYYYMMDD 형식)입니다.

  • 001 001 에서 시작하여 특정 API 리소스 버전을 대상으로 하는 이전 버전과 호환되지 않는 모든 반복에 대해 1 씩 증가합니다.

v20230201001.0.0 버전은 2월자 버전이 지정된 용 Go SDK 라이브러리의 초기 출시하다 를 API 1나타내며, 2023 다른 단절적 변경 사항, 반복 또는 수정 사항이 없습니다.