Apidog IntelliJ IDEA プラグイン

Apidog Fast Request は、IntelliJ IDEA向けにApidogが提供するプラグインだ。JavaやKotlinプロジェクトのソースコードを解析し、API仕様を自動生成してApidogプロジェクトと同期できる。

Java/KotlinのアノテーションやJavadoc/KDocコメントを解析することで、詳細で体系的なAPI仕様を生成できる。

対応しているフレームワークとライブラリ：

種類	名称	アノテーション例
Web フレームワーク	• Spring • Jakarta RESTful Web Services (JAX-RS)	@RestController, @GetMapping @Path, @Get
バリデーション	• Jakarta Bean Validation • Java Bean Validation	@NotNull
シリアライズ	• Jackson • GSON	@JsonProperty @SerializedName
API 仕様ライブラリ	• Swagger 2.x • Swagger/OpenAPI 3.x	@ApiOperation, @ApiParam
永続化	MyBatis
クライアント	Spring Cloud OpenFeign
モニタリング	• Spring Boot Actuator
言語とコメント	• Java: Javadoc • Kotlin: KDoc

1. インストール

IntelliJ IDEAのプラグインマーケットプレイスでApidog Fast Requestを検索してインストールする。

このプラグインはIntelliJ IDEA 2019.3以降のバージョンに対応している。

Apidog Fast Request プラグインを使用する前に、Apidogアカウントを登録し、APIアクセストークンを生成する必要がある。詳しい手順はAPIアクセストークンの生成を参照。

Apidog Fast Request で、APIアクセストークンを入力し、「トークンのテスト」をクリックする。テストが成功したら、「適用」または「OK」ボタンをクリックして、通常通り Apidog Fast Request を使用できる。

以下の範囲でAPIのアップロードをサポート：

モジュール内のすべてのAPI：左側のディレクトリツリーでモジュールノードを右クリックし、「Apidogにアップロード」を選択

Controller内のすべてのAPI：Controllerファイル内で右クリックし、「Apidogにアップロード」を選択

Apidogへの初回アップロード時には、対象プロジェクトの選択を求めるポップアップが表示される。プロジェクトまたはプロジェクト内のフォルダを選択できる。プロジェクトを選択すると、APIはプロジェクトのルートフォルダにアップロードされる。

Schemaの設定は不要だ。API仕様は、APIが配置されているプロジェクトのSchemaルートフォルダにデフォルトでアップロードされる。

アップロード完了後、Apidogを開き、右上の更新ボタンをクリックすると、JavaやKotlinのソースコードから生成されたAPI仕様を確認できる。

その後、APIドキュメントを簡単に共有でき、他の人がブラウザで便利に閲覧できる。詳しい手順は共有ドキュメントを参照。

Apidog Helper プラグインは、ローカルマシン上でのJavaとKotlinのソースコード検出のみを実行する。Apidogではデータ資産のセキュリティを最優先し、JavaとKotlinのソースコードがApidogサーバーにアップロードされることは決してない。

Apidog Helper プラグインの使用中に問題が発生した場合や、フィードバックがある場合は、support@apidog.comまでご連絡いただくか、Discordコミュニティにご参加ください。