Pin フレームワークでの API ドキュメントと自動テストの詳細な説明-Golang-php.cn

Pin フレームワークでの API ドキュメントと自動テストの詳細な説明

王林

リリース： 2023-06-22 21:43:18

オリジナル

2370 人が閲覧しました

Gin は Golang で書かれた Web フレームワークで、効率性、軽量性、柔軟性、比較的高いパフォーマンス、そして使いやすさという利点があります。 Jin フレームワークの開発では、API ドキュメントと自動テストが非常に重要です。この記事では、Gin フレームワークでの API ドキュメントと自動テストについて詳しく説明します。

1. API ドキュメント

API ドキュメントは、他の開発者の使用と理解を容易にするために、すべての API インターフェイスの詳細情報を記録するために使用されます。 Jin フレームワークは、Swagger、Go Swagger、ReDoc など、さまざまな API ドキュメントツールを提供します。この記事では、Swagger を例として説明します。

Swagger のインストール

Gin フレームワークに Swagger を統合すると非常に便利です。まず、ターミナルで次のコマンドを使用して Swagger をインストールする必要があります。

$ go get -u github.com/swaggo/swag/cmd/swag

ログイン後にコピー

インストールが完了したら、次のコマンドを使用して Swagger ドキュメントを生成できます。

$ swag init

ログイン後にコピー

API インターフェイスのコメントを記述するときは、特定の形式で記述する必要があります。例:

// @Summary Get user by ID
// @Description Get user information by ID
// @Tags Users
// @Produce json
// @Param id path int true "User ID"
// @Success 200 {object} User
// @Router /users/{id} [get]

ログイン後にコピー

このうち、

@summary はインターフェイスの簡単な説明を表し、@Description はインターフェイスの詳細な説明を表し、@ Tags は、それが属するインターフェイスを表します。 label、@Produce は、インターフェイスの応答コンテンツタイプを表します。 @Param は、インターフェイスのパラメーターを表します。 @ Success はインターフェイスの応答を表し、@Router はインターフェイスのルートを表します。

コメントを書き込んだ後、Swagger ドキュメントを生成する必要があります。次のコマンドを使用するだけです:

$ swag init

ログイン後にコピー

ドキュメントが正常に生成されたら、ブラウザで

http://localhost:8080/swagger/index.html にアクセスして Swagger ドキュメントを表示します。

2. 自動テスト

自動テストとは、プログラムを使用して手動テストの代わりにテストケースを自動的に実行するプロセスを指します。 Jin フレームワーク開発では、自動テストによりテスト時間を節約し、テスト効率を向上させることができます。

Ginkgo は、BDD (動作駆動型開発) スタイルのテストを実行できる Golang テストフレームワークです。 Gomega は、テスト結果を簡単に確認できるマッチャーライブラリです。これら 2 つのライブラリをインストールするには、次のコマンドを使用できます:

$ go get -u github.com/onsi/ginkgo/ginkgo
$ go get -u github.com/onsi/gomega/...

ログイン後にコピー

テストを作成するときは、新しい _test.go ファイルを作成する必要があります。 BDD スタイルでテストコードを作成します。例:

Describe("User Handler", func() {
    Context("when getting user information", func() {
        It("should return status code 200", func() {
            // 发起HTTP请求
            r, _ := http.NewRequest(http.MethodGet, "/users/1", nil)
            w := httptest.NewRecorder()
            router.ServeHTTP(w, r)

            // 验证状态码
            Expect(w.Code).To(Equal(http.StatusOK))
        })
    })
})

ログイン後にコピー

上記のテストコードでは、最初に

Describe を使用してテスト名を定義します。次に、Context を使用してテストシナリオを定義し、It を使用してテストケースを定義します。テストケースでは、HTTP リクエストを開始し、マッチャーを使用してテスト結果を検証します。

テストコードを作成した後、次のコマンドを使用してテストを実行できます。