Goで自動でAPIインターフェースを生成する方法
一般的に、Go でオープンソースのツールやライブラリを使用して API のインターフェースコードを自動生成できます。
- APIインターフェースの構造や定義をSwagger/OpenAPI仕様で定義する。Swaggerとは、APIのリクエスト・レスポンスの構造や、APIのパス、パラメータなどの情報を記載するためのRESTful APIのドキュメント仕様です。
- Swagger仕様に従い、golang用のAPIインターフェイスコードを生成するコマンドラインツールであるgo-swaggerを使用してコードを生成する。
- 最初にプロジェクトにgo-swaggerツールをインストールしましょう: go get -u github.com/go-swagger/go-swagger/cmd/swagger
- 次に、プロジェクトのルートディレクトリに、API の構造と定義を定義するための swagger.json または swagger.yaml ファイルを作成します。
- 次に、プロジェクトのルートディレクトリで次のコマンドを実行してコードを生成します: swagger generate server -A -f
はアプリ名、 は swagger.json 又は swagger.yaml ファイルのパスを置き換えてください。
- Go-Swaggerはswagger specを元にAPIインターフェースコードを生成し、./cmd//restapi以下に出力します。
- 必要に応じて生成されたコードを修正します。生成されたコードは単なる枠組みであり、独自のビジネスニーズに基づいて若干の修正とカスタマイズが必要になる可能性があります。
- 生成されたコードを基に、通常のgo buildとgo runコマンドでアプリケーションを構築して実行できます。
APIコードの自動生成は最初のフレームワークにすぎない場合があり、特定のアプリケーションのニーズを満たすために追加の開発と調整が必要になる可能性があることに注意してください。