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ドキュメントコメントで識別される読み取り専用フィールドまたは書込み専用フィールドが含まれる場合があります。

GoDoc コメントを使用して、フィールドを読み取り専用と書込み専用として注釈を付けます。

// Read Only field. は、フィールドが応答には含まれるがリクエストには含まれないことを意味します
// Write Only field. は、フィールドがリクエストに含まれる可能性があるが、応答には含まれないことを意味します

例

SDK の使用の詳細については、基本的な例を参照してください。

リリース戦略（セマンティックバージョン管理）

Atlas Go SDK は、セマンティックバージョン管理 (SemVer) 仕様に従います。この SDK に使用されるバージョン管理スキームは次のとおりです: vYYYYMMDDXXX.Y.Z 、ここではです。

YYYYMMDDXXX メジャーのバージョン番号を表しますこれには、SDK が使用するバージョン管理されたAPI リソースバージョンの日付が含まれ、その後に他の重大な変更に対して 3 桁の数字が含まれます。
Y は、マイナーバージョン番号を表し、同じバージョン管理 API リソースの中断されていない反復処理を示します。
Z はパッチのバージョン番号を表し、ユーザーに影響のない SDK の修正を示します。

バージョン管理ルール

Major Version (vYYYYMMDDXXX.0.0)

メジャーバージョンの増加は、SDK の重大な変更を意味します。メジャーバージョンの増加に関するルールは次のとおりです。

メジャーバージョンには、 Versioned API の日付と、その他の重大な変更の場合は 3 桁を含める必要があります。
新しいバージョン管理された API リソースバージョンが導入されると、SDK に重大な変更が加えられ、バージョン識別子が増加します。たとえば、メジャーバージョンが 1 年後にリリースされた場合、 vYYYYMMDDはv20300101になります。
Versioned API とは無関係で、SDK にその他の重要な重大な変更がある場合は、メジャーバージョンの最後の 3 桁を増やします。

Minor Version (vYYYYMMDDXXX.Y.0)

マイナーバージョンインクリメントは、対象をバージョン管理された API の反復に基づいて、Atlas Go SDK リリースを表します。 MongoDB が以前のマイナーバージョンと下位互換性のある SDK に新しい機能または拡張機能を追加する場合は、マイナーバージョンを増やします。

Patch Version (vYYYYMMDDXXX.Y.Z)

パッチバージョンの増分は、ユーザーに影響を与えない SDK の修正と改善を示します。

バージョン例: v20230201001.0.0

サンプルバージョンv20230201001.0.0を分解して、そのコンポーネントを理解しましょう。

メジャーバージョン: v20230201001.0.0
- v : バージョン番号の開始を示します。
- 20230201 : この SDK が使用しているバージョン管理された API バージョンの日付（形式はYYYYMMDD 。
- 001 は001から開始され、特定の API リソースバージョンを対象とする下位互換性のない反復ごとに1ずつ増加します。

バージョンv20230201001.0.0 は、Go API1、日付の Versioned 用 SDK2023 ライブラリの初回リリースを表し、その他に重大な変更、反復、または修正はありません。

戻る

認証

Error Handling