DOCSEARCHbyAlgolia
Submit Docs

Api Buddy

website·Indexed 32 days ago

http://api-buddy.com/

A JetBrains IDE plugin (also referred to as Fast Request) designed for API development and debugging. It features AI-powered parameter optimization, API documentation generation and synchronization to GitHub/Gitee/GitLab, Apifox integration, cURL import/export, and environment variable management.

Tokens
25.7K
Snippets
62
Records
333
Agent score
50%

What's inside Api Buddy

  1. Overview of Api Buddy (Fast Request) features

    Api Buddy (Fast Request) is an intelligent API debugging plugin for IntelliJ IDEA. It is designed to streamline the API testing process by automating request generation and providing advanced management tools.

    Key capabilities include:

    • API Generation & Management: One-click API generation with human-centric parameter strategies, API saving, grouping, and navigation.
    • Integration: Support for exporting APIs to Postman, Apifox integration, and OpenAPI export.
    • AI Enhancements: AI-powered parameter optimization and general AI assistance.
    • Developer Productivity: SearchEveryWhere support for interface names, cURL import/export, project-level global parameter support, and automatic recognition of Yaml and Properties files.
    • Documentation: Online document support, API document synchronization, and batch export of API documentation.
    • Request Control: Ability to terminate API requests and preview historical requests.

  2. Overview of API Buddy scripting capabilities

    API Buddy provides scripting functionality that allows developers to flexibly and dynamically modify request parameters and handle response data during the API request process.

  3. Overview of Fast Request for IntelliJ IDEA

    Fast Request is a powerful RESTful API toolkit plugin for IntelliJ IDEA, designed to simplify API debugging, management, and searching. It allows developers to quickly generate URLs and parameters based on existing methods within the IDE. Key capabilities include executing requests, inspecting server responses, storing API requests, and exporting them. Compared to the built-in HTTP Client, it provides a more intuitive user interface, flexible parameter customization, and integrations with Postman and Swagger.

  4. Overview of Groovy Scripting for API Customization

    Developers can use Groovy scripts to implement custom logic for APIs, such as dynamic encryption, signing, or modifying headers. Scripts are categorized into Pre-scripts (executed before the request) and Post-scripts (executed after the request).

  6. Optimize AI responses using Overview and Examples

    To improve the precision of AI responses, use the three-dimensional configuration: Overview (概述), Question Example (提问范例), and Example Result (提问范例结果). This allows the AI to be 'trained' on a specific Q&A pair to ensure the output matches expectations. Use the Overview to describe the problem scope and the examples to provide concrete input/output samples.
    // Example: Optimizing JSON payloads

Overview:
"You are an excellent JSON processor. Whenever a user sends you JSON, you should respond in a fixed JSON format and replace the values in the JSON fields with human-readable content based on the meaning of the JSON keys. You only modify the values without changing the structure."

Question Example:
{"id":1,"title":"title_ahska","simpleDesc":"simpleDesc_ohga1","content":"content_yujga"}

Example Result:
{"id":1,"title":"书画标题","simpleDesc":"简介内容","content":"整体内容"}

  8. Use scripts to dynamically modify API requests and responses

    Starting from version 2022.2.3, the product supports scripts that allow developers to flexibly and dynamically modify request input parameters and handle API responses. Detailed implementation guidance can be found in the script documentation.

  9. API Grouping and Navigation improvements in v2.1.2

    Version 2.1.2 includes several UX improvements for API management:

    • API Grouping: When saving an API, it is now automatically saved into a group based on the controller name, making the organization more intuitive.
    • Lazy Loading: The API Navigate tree is now lazy-loaded upon the first opening of IntelliJ IDEA to improve startup performance.
    • Search Everywhere: Added module identifiers to the 'Search Everywhere' functionality for better API discovery.
    • UI Optimization: General display improvements to the API navigate tree.

  10. Use Header Presets to manage request headers

    Header Presets allow users to create different groups of headers and manage their respective request headers. Users can quickly add preset header parameters via a dropdown menu.

  12. Handle special characters in URL query parameters

    The tool now automatically handles special character encoding for values within URL query parameters, removing the need for users to manually encode parameters before sending requests.