Apidog IntelliJ IDEA プラグイン
Apidog Fast Request
は、IntelliJ IDEA向けにApidogが提供するプラグインだ。JavaやKotlinプロジェクトのソースコードを解析し、API仕様を自動生成してApidogプロジェクトと同期できる。種類 | 名称 | アノテーション例 |
---|---|---|
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. インストール

2. API アクセストークンの生成
Apidog Fast Request
プラグインを使用する前に、Apidogアカウントを登録し 、APIアクセストークンを生成する必要がある。詳しい手順はAPIアクセストークン の生成を参照。Apidog Fast Request
で、APIアクセストークンを入力し、「トークンのテスト」をクリックする。テストが成功したら、「適用」または「OK」ボタンをクリックして、通常通り Apidog Fast Request を使用できる。
3. APIのアップロード


4. APIドキュメントの確認
プライバシーとセキュリティに関する声明
Apidog Helper
プラグインは、ローカルマシン上でのJavaとKotlinのソースコード検出のみを実行する。Apidogではデータ資 産のセキュリティを最優先し、JavaとKotlinのソースコードがApidogサーバーにアップロードされることは決してない。お問い合わせ
Apidog Helper
プラグインの使用中に問題が発生した場合や、フィードバックがある場合は、support@apidog.comまでご連絡いただくか、Discordコミュニティにご参加ください。