Apidog Update: Tarsh, Performance Boost, Schemas
Apidog November Update: trash, performance boost, response modification with post-scripts, extracting request content as a data structure.
We listen to the voice of our users and constantly update based on real business scenarios. Take a look at the new features that Apidog brings this time and see if there is one that you are concerned about.
Trash
In daily use, it is possible for users to accidentally delete an interface. In order to reduce the inconvenience caused by this situation, we have added a Trash.
The interface documents, interface test cases, schemas, new requests, and Markdown documents that have been deleted in the interface directory will continue to be kept in the trash for 30 days. During this period, the deleted data can be recovered.
If there are more contents in the trash and you can't find the mistakenly deleted contents quickly, we also support filtering by types of content, editor, and other dimensions.
Performance Improvement
We have optimized all aspects of Apidog's performance for a smoother experience, whether browsing documents or modifying interfaces.
Post Processor Script Modifies Response Content and can Decode Content
In real business scenarios, some API interfaces' response content undergoes encryption or encoding processing, such as Base64 encoding. This encoded response content cannot be read directly, making it difficult to intuitively view the operation results.
To solve this problem, we now support using a post-processors to modify the response. By using a custom script, we can decode the API's response and display it in the body.
In the example shown in the following image, the value of the "data" field in the API's returned response has been encoded with Base64. How can we decode it and preview it directly in the body preview interface?
In the new version of Apidog, we can add a custom script in the post-request script section, which uses CryptoJS to decode Base64, and then uses the new method pm.response.setBody() to directly modify the Response's Body.
Including the modification of the Response's Body, the pm object's response and mock Response objects have added the following methods:
- set body(body: any): modify the Body of the response, the parameter supports JSON or string;
- setCode(code: number): only effective for pm. mock response, modify the HTTP status code of the response;
- set delay(milliseconds: number): only effective when using pm.mock Response in advanced Mock's custom script, set the Mock response delay;
- original Json(): get the original Body in JSON format (unaffected by setBody);
- originalText(): get the original Body in text format (unaffected by setBody).
You can flexibly apply these capabilities in different scenarios to meet diverse needs.
Extracting Request Content as Data Structure and Sample Value
Sometimes, your workflow is to debug the interface first, and then write the documentation based on the debugging results, rather than write the documentation first and then debug it.
To simplify the process of writing interface, we now support directly extracting the Request Body from the interface's running page as the data structure and sample value in the interface document.
Project Members can Trigger Automatic Import that has been Configured
After the project owner configures the rules for automatic data import, the task of automatic import will be executed regularly. In some scenarios, we need to import data immediately instead of waiting for it to be imported automatically.
Previously, only the project owner had permission to perform the immediate import. Now, ordinary members of the project can also perform immediate import operations, but cannot modify the relevant configuration for automatic import.
Other Features
In addition to the above, the engineers at Apidog have made a lot of efforts:
🔥 [New feature] Added an "About Apidog" page in the software settings in the lower left corner, which allows you to quickly check and update the software version, as well as view the update log.
🔥 [New feature] When clicking on the close button in the upper right corner, the Windows version now supports minimizing to the system tray.
⚡️ [Optimization] Optimized the logic of coverage when extracting the interface document from the response.
⚡️ [Optimization] Improved the search function for environment and service (prefix URL).
⚡️ [Optimization] Optimized the click area of the directory tree.
⚡️ [Optimization] Added a title prompt for the send request operation, which can be operated using the shortcut key ⌘ Enter.
⚡️ [Optimization] Improved compatibility for entering passwords with spaces when opening shared online interface documents.
⚡️ [Optimization] Removed the duplicate first-level URL information from the redirect URL part in the interface debugging request result.
⚡️ [Optimization] Increased the maximum input value for the request timeout limit to 10 hours.
⚡️ [Optimization] The "Jump" button is no longer displayed in the "Public Project" tab of the main window.
⚡️ [Optimization] If an interface initialization error occurs on the login page, a network error page will be displayed.
For more details, please refer to the official documentation:
download page for Apidog client:
We will always be committed to saving every minute of your development team's time, and we thank you for your valuable feedback on our product.
If you need any help during the use of Apidog, please feel free to contact us via email.