メインコンテンツまでスキップ

IntelliJ IDEA プラグイン

EchoAPI for IDEA Plugin Overview​

このIDEAプラグインは、コードから包括的なAPIドキュメントを自動に作成することで、開発プロセスの効率を向上させます。また、作業の生産性を向上させるために設計されたツールとして、迅速なデバッグ、カスタムAPIの作成、安全なデータ同期、柔軟なパラメータ解析、軽量なデザインなどさまざまな機能も提供しております。

1. プラグインのインストール​

  • IntelliJ IDEAを開きます。
  • プラグインマーケットプレースに移動します。
  • "EchoAPI for IDEA"プラグインを検索します。
  • プラグインを選択し、右上隅にある"インストール"ボタンをクリックします。
  • インストール後、IDEAを再起動してプラグインを有効にします。 download EchoAPI.png

2. 主な機能​

1. 自動コードインターフェースおよびディレクトリ認識​

  • 機能の説明: プロジェクトのコード構造を自動的に認識し、コメントやクラス定義に基づいて対応するインターフェースとディレクトリを生成します。
  • 使用方法:
    1. プロジェクトを開きます。
    2. システムがコードをスキャンし、自動的にインターフェースとディレクトリを生成します（設定で認識ルールを調整できます）。
    img_v3_02di_55c8b6ef-15e0-4bcd-9086-9e0c4a28726g.png

2. インターフェースとディレクトリを手動で作成する​

  • 機能の説明: ユーザーが新しいインターフェースやディレクトリを手動で追加し、組織と管理を最適化することができます。
  • 使用方法:
    1. **"新しいインターフェース"** または **"新しいディレクトリ"** をクリックします。
    2. 名前を入力し、**"OK"** をクリックして作成します。新しいインターフェースまたはディレクトリがリストに表示されます。
    image.png

3. クラウドデータのプッシュとプル​

⚠️ 注意: データをプルすると、既存のインターフェースが上書きされます。プッシュする際は、クラウドデータとローカルデータのいずれかを選択して問題を解決してください。

  • 機能の説明: ローカルデータをクラウドにプッシュしたり、クラウドからデータをプルしたりします。

  • 使用方法:

    1. **"データをプッシュ"** をクリックしてローカルデータをクラウドにアップロードします。

    image.png 2. "データをプル" をクリックしてローカルデータを更新します。 image.png 3. 操作が成功したら、デバッグインターフェースに移動したりリンクを共有したりできます。 image.png

  • メソッド:

    1. コードのメソッド、クラス、パッケージ、またはモジュールを右クリックしてインターフェースをプッシュします。

    image.png 2. インターフェースツリーを右クリックしてインターフェースをプッシュします。モジュール、パッケージ、クラス、およびメソッドがサポートされています。 image.png 3. 操作には "プッシュ" と "プル" アイコンを使用します。 image.png

4. インターフェースデバッグ機能​

  • 機能の説明: デバッグ機能を提供し、履歴レコードを保存し、レスポンスステータスを確認し、JSONダウンロードをサポートします。
  • 使用方法:
    1. インターフェースデバッグインターフェースを開きます。
    2. **"保存"** ボタンをクリックし、レコードを保存するためのインターフェース名を入力します。
    image.png 4. "レコードを保存" をクリックします。各メソッドごとに最大20件のリクエストレコードを保存できます。 image.png 5. "送信" をクリックしてインターフェースをデバッグし、レスポンスとステータスコードを表示します。 image.png 6. データをJSONファイルとして保存するには、ダウンロードボタンをクリックします。 image.png

    (オプション) グローバルリクエストヘッダーとホストを設定します。入力ボックスがフォーカスを失った後にグローバルヘッダーを保存します。ホストはこの手順を必要としません。

3. インターフェースアップロード設定​

🌍 アクセス方法: EchoAPI Config - 認証.

1. クラウドドメイン構成​

クラウドドメインアドレス: https://open.echoapi.com（変更しないでください）

2. クラウドアカウント​

  • 機能の説明: EchoAPIクラウドアカウントにログインして、ローカルデータをクラウドに迅速に同期したり、クラウドからデータをプルしたりして、データが失われないようにします。
  • 使用方法:
    1. **"EchoAPIにサインイン"** ボタンをクリックします。
    image.png 2. Google、GitHub、またはメール/パスワードでログインします。 image.png 3. アカウントを持っていない場合は、登録するために "アカウントを作成" をクリックします。 image.png 4. ログアウトするには "サインアウト - データをクリア" をクリックします。ローカルリストのクラウドプロジェクトデータがクリアされ、再ログイン時にクラウドデータを再度プルする必要があります。 image.png

    🌍 アクセス方法: EchoAPI Config - プッシュ設定.

3. インターフェースとディレクトリのアップロード方法​

  • 機能の説明: インターフェースがクラウドにプッシュされる方法を構成します。
  • 使用方法:
    1. **モジュールとクラスコメントディレクトリを自動作成:** アップロード時にプロジェクトを選択し、システムが親モジュールとクラスコメントディレクトリを自動的に作成します。
    2. **プロジェクトディレクトリを手動で選択:** アップロード時に特定のディレクトリまたはプロジェクトを選択します（デフォルト）。
    image.png

4. アップロードホストの設定​

  • 機能の説明: データのアップロードのためのホストアドレスを構成します。
  • 使用方法:
    1. **デフォルト構成:** システムは自動的に構成ファイルからポートと `server.servlet.context-path` を使用します。
    2. **ホスト設定を空にする:** アップロードに対してシステムは相対パスのみを使用します。EchoAPIクライアント環境設定でホストアドレスを指定できます。
    image.png

5. アップロードパラメータの設定​

  • 機能の説明: データアップロードプロセスに関連するパラメータを構成します。
  • 使用方法:
    1. **パラメータの命名規則:** パラメータ名の形式を定義します。
    2. **親クラスのプロパティを入出力に含める:** 親クラスのプロパティを含めるかどうかを選択します。
    3. **シリアライズ不要なパラメータ:** シリアライズが不要なパラメータをリストします。
    4. **パラメータのマッピング:** 異なるパラメータ名のマッピング関係を設定します。
    image.png

4. 追加機能​

1. リフレッシュ​

  • インターフェースツリーリストを更新して最新のインターフェースデータを取得します。

2. 検索機能​

  • インターフェースコメントを検索します: Mac: Command+\ | Win: Ctrl+.
  • インターフェースツリーを検索します: Mac: Option+\ | Win: Alt+.

3. インターフェースツリーの展開と折りたたみ:​

  • すべて展開: インターフェースツリー全体を展開します。
  • すべて折りたたむ: インターフェースツリー全体を折りたたみます。

4. 並列インターフェースデータ表示​

  • 横: 左側にインターフェースリストを表示し、右側に詳細を表示します。 image.png
  • 縦: 上部にインターフェースリストを表示し、下部に詳細を表示します。 image.png

5. クラウドアカウントプロジェクトリスト表示​

  • 未ログイン: ローカルのチームとプロジェクトを表示します。 image.png
  • ログイン済み: クラウドとローカルのチームプロジェクトを表示します。（ログアウトすると、ローカルリストのクラウドプロジェクトデータがクリアされ、再ログイン時にクラウドデータを再度プルする必要があります。） image.png

6. ヘルプドキュメント​

  • ユーザーガイドにアクセスするにはクリックしてください。

7. お問い合わせ​

  • メールでお問い合わせするにはクリックしてください。

8. ガイド機能​

  • コード部分の左側にある矢印をクリックして、インターフェースツリーに移動します。 image.png
  • インターフェースツリーのインターフェースをクリックして、コード部分に移動します。 image.png

5. IDEAコーディング規約​

  • Java標準に従う: コードはJavaプログラミング規約に従う必要があります。
  • インターフェースの命名: メソッドにコメントが含まれている場合、インターフェース名が自動的に生成されます。デフォルトのインターフェースパスはメソッド名になります。
  • Swagger 3.0をサポート: システムはSwagger 3.0の注釈をサポートしています。
  • 入力パラメータのコメント: 入力パラメータのコメントが欠けていると、アップロード機能に影響を与える可能性があります。

サンプルコード​

/* 
 * これはクラスのコメントです 
 * @author EchoAPI at 2024/08/01 13:48 
 */
@RestController
@RequestMapping("api")
public class AController {

    /*
     * ユーザー情報
     * @author EchoAPI at 2024/8/1 14:14
     */
    @Data
    public class User {
        /*
         * ID
         */
        @ApiModelProperty(value = "id")
        private Long id;
        /*
         * ロールリスト
         */
        private List roleList;
        /*
         * ロールオブジェクト
         */
        private Role role;
    }
}

6. お問い合わせ​

お気軽にお問い合わせください。最新機能を体験するには、カスタマーサービスにお問い合わせいただくか、プラグインのベータグループにご参加ください！