Skip to main content

FAQ

Keywords meaning

S: Skill Q: Question A: Answer

We will constantly update the problems encountered by developers and the corresponding solutions.

S: Quickly add domain

Please refer Project-level domain config (Plugin version>=2023.1.1)

S: APIs lost

So sorry to inform you that installing the 2023.1.3 version of (have been hidden) will cause loss of historical APIs, and you will need to manually retrieve the data. Here's what you need to do:

  1. Download 2023.1.3.2+ version of plugin
  2. Go to the .idea directory in your project, right-click and click on "Local history", find the change log about .idea/FastRequestCollection.xml (the title contains "Deleting"), and locate the last version. Copy the contents of this version and paste them into .idea/fastRequest/fastRequestCollection.xml
  3. Restart IntelliJ IDEA.
  4. Click on the icon in the APIs tab and do transfer

dataTransfer20231

S: Url error

urlError

Solution
  1. Configure the correct domain name and enable the 2 drop-down boxes for the project and environment
  2. Set the correct URL, for example, to replace the variable {id} on the URL, you can replace the variable in the Path Param tab

S: How to ignore the field of the entity

Way 1: Use one of the following 2 annotations.

com.fasterxml.jackson.annotation.JsonIgnore

com.alibaba.fastjson.annotation.JSONField(serialize = false)

Way 2: Add the static modifier to the field.

Way 3: Add @parseIgnore in comment

/**
 * xxx description
 * @parseIgnore
 */
private String someIgnoreField;

S: Quick locate

After getting the focus of the window or pop-up box, enter the letters to position, then use the ↑ arrow or the ↓ arrow for jump position

For example:

apiDocExample

S: Multi-file upload

Enter multiple values and set the field type to file

multiFileUpload

S: Pass text/plain param in body

Please add Content-Type: text/plain in the header

Consider using add header by Common header

S: No controller, how to send a request

Refer to Temporary request

S: Get code hints while writing scripts

Copy the code and delete it after finish the script

import cn.hutool.http.HttpUtil

def request = HttpUtil.createGet("shouldremove")
def response = request.execute()

S: API doc sync

When you modify your method, the API returned from the APIs list is the API saved before you update it. At this time, if you want to ensure that the online API document is your modified one, you need to click (save) or click again and then sync api doc.

Recommendation: There is no need to create a repo in Github, Gitee, and Gitlab in advance. Plug-ins will automatically help create a repo. Developers only need to provide the repo name.

S: APIs echo

For the saved API, you modify it again, and you need manually fill in the parameters and save it. If you don't want the parameters you saved before at all, you can just click (Re generate).

Please ensure that click save button every time you modify api params.

S: Best Visual Effects

Adjust tool window width to 610+ pixel and will achieve the best visual effect

Q: Header likes Origin not effect

Because the restrictedHeaders strategy of sun.net.www.protocol.http.HttpURLConnection . If you want to use the following headers, you need to configure vm parameters for IDEA

private static final String[] restrictedHeaders = {
        /* Restricted by XMLHttpRequest2 */
        //"Accept-Charset",
        //"Accept-Encoding",
        "Access-Control-Request-Headers",
        "Access-Control-Request-Method",
        "Connection", /* close is allowed */
        "Content-Length",
        //"Cookie",
        //"Cookie2",
        "Content-Transfer-Encoding",
        //"Date",
        //"Expect",
        "Host",
        "Keep-Alive",
        "Origin",
        // "Referer",
        // "TE",
        "Trailer",
        "Transfer-Encoding",
        "Upgrade",
        //"User-Agent",
        "Via"
    };

Click help->Edit Custom Vm Options...,add the following config in idea.vmoptions(linux) or idea64.exe.vmoptions(windows)

-Dsun.net.http.allowRestrictedHeaders=true

Q: Action buttons are not visible

Click Options and check Show Toolbar

Q: Generate parameters、jump error

A: Do not have methods with the same method name in the controller code

Q: Tab not displayed in SearchEveryWhere under new UI

A: Change the theme of IDEA toDark. Steps：Open SearchEveryWhere -> Fill in 'theme' -> Enter or confirm and switch the theme to Dark. This is a bug caused by the IDEA theme.

Q: Left icon missing

Left icon missing.

A: Open config setting->Editor->Gutter icons->show gutter icon

Q: After entering the parameters, the API call found that the parameters were invalid

A: Plugin version less than 2022.2.3, when editing a value in the table, you need to click in the blank space after editing the value, then send the request. The bug has been fixed in the 2022.2.3+ version.

Q: Why the plugin doesn't respond

A: Please configure the relevant configuration according to the steps introduced in the first chapter first, and then click the icon.

Q: Idea freezes after clicking the fastRequest icon

A: :The entity class you designed is nested and recursive, the plugin does not support.

public class A{
    private B b;
    private int xx;
}
public class B{
    private A a;
    private String xx;
}

If you don't need the B property in the above case, then you can manually add a static keywords to property B when generating

public class A{
    private static B b;
    private int xx;
}