DOCSEARCHbyAlgolia
Submit Docs

Apipost API Development Collaboration Platform

website·Indexed 32 days ago

https://v7-wiki.apipost.cn

An integrated API development and collaboration platform supporting API design, debugging, and automated testing. Key features include real-time multi-user collaboration, Mock URL generation, environment variable management, and support for importing projects from Postman, Swagger (OpenAPI v2/v3), and Yapi. It provides pre-execution and post-execution scripts for assertions and data processing, as well as an IDEA plugin for integrated development.

Tokens
27.9K
Snippets
108
Records
277
Agent score
59%

What's inside Apipost

  1. Overview of Apipost API Lifecycle Modules

    Apipost provides five core modules to manage the full API development lifecycle using a single data source to ensure real-time synchronization across roles:

    1. API Design: Pre-define request parameters and response expectations (Mock) before development. Supports visual Json-schema for generating Mock data structures (v7+).
    2. API Debugging: Validate interfaces during development. Supports HTTP, WebSocket, gRPC (v7+), and TCP/UDP (v7.2.2+). Pre/post-execution scripts and assertions are 100% compatible with Postman.
    3. Automated Testing: Perform complex scenario testing. Supports controllers similar to JMeter, including conditional, loop, wait, global assertion, and script controllers (v7+).
    4. API Documentation: Generate standardized documentation in HTML, Markdown, and Word formats. Supports custom logos (v7+).
    5. IDE Plugin: Allows debugging interfaces and scanning code to upload interfaces and generate documentation directly within the IDE.

  2. Overview of Apipost Automated Testing Controllers

    Starting from version 7.0.13+, Apipost supports several controllers for complex business testing. These controllers support infinite nesting:

    • Iteration Loop (次数循环): Repeats a set of steps a specific number of times.
    • While Loop (while循环): Repeats steps as long as a condition is met.
    • Transaction Group (事物分组): Groups related requests together.
    • If Condition Branch (if条件分支): Executes steps based on a conditional check.
    • Global Assertion (全局断言)
    • Javascript Script (Javascript脚本)
    • HTTP Interface (HTTP接口)

  3. Overview of apipost WebHooks

    Starting from version v7.1.0, apipost supports third-party WebHook capabilities. This allows users to drive business workflows by sending notifications to external platforms based on specific triggered events. Currently, supported channels include Feishu and Enterprise WeChat.

  4. Overview of APIPOST Mock Service

    APIPOST provides a Mock service that allows developers to receive realistic interface data without a functioning backend. This enables frontend-only demonstrations during early project stages and facilitates decoupled frontend and backend development by simulating data responses.

  5. Overview of ApiPost Pre-request Scripts

    Pre-request scripts are executed immediately before a request is sent. They are used to perform complex calculations, manage environment and global variables, dynamically modify request parameters (headers, query, body), and send auxiliary HTTP requests.

  6. Understand Global Variables in ApiPost

    Global variables in ApiPost are project-wide variables that remain effective regardless of the current environment, as long as they are within the same project. They are accessed using the same syntax as environment variables: {{variableName}}.

  7. Understand Project Owner roles and permissions in ApiPost

    The Project Owner is the individual who created the project. They have full administrative control, including the ability to manage the project (transfer across teams, clone, hand over ownership, and change member permissions), edit and view APIs, and invite members with either read-write or read-only permissions. Note: Only users with read-write seats within a team are permitted to create projects.

  8. Manage session cookies with the Cookie Manager

    The Cookie Manager in ApiPost is used to save and manage cookies returned by servers during API requests. Once a cookie is stored in the manager, it is automatically attached to subsequent API requests that require those cookies, ensuring session persistence across different interface calls. The manager allows users to perform CRUD (Create, Read, Update, Delete) operations on stored cookies.

  9. Define API Design for Mocking

    The API Design module is specifically used to pre-define interface request parameters and response expectations to generate a Mock URL. For simple interface debugging without the need for a mock server, use the API Debugging module directly.

  10. Use real-time multi-user collaboration in Apipost

    Apipost supports real-time online collaboration for two or more users. Changes made by one member (such as creating a new API interface) are automatically and immediately synchronized to all other collaborators without requiring a manual page refresh. The collaboration system includes features to view currently online collaborators, a conflict resolution mechanism, and the ability to trace collaboration logs and invite new members instantly.

  11. Understand the structure of the APIPOST response object

    The response object in APIPOST provides comprehensive metadata about the HTTP response received from a server. It includes timing information, network details, status codes, and various formats of response headers and cookies.
    {
    "target_id": "8ad7d334-5181-43d7-a476-f4659eebed21",
    "responseTime": 285,
    "responseSize": 0.31,
    "resposneAt": "01:43:44",
    "netWork": {
        "agent": "Desktop-Agent",
        "address": {
            "remote": {
                "address": "122.114.104.58",
                "family": "IPv4",
                "port": 443
            }
        }
    },
    "status": "OK",
    "code": 200,
    "timingPhases": {
        "wait": 0.48262500017881393,
        "dns": 58.130667000077665,
        "tcp": 35.37691699992865,
        "firstByte": 109.4776669992134,
        "download": 1.4745420003309846,
        "total": 285.3353340001777,
        "secureHandshake": 80.39291600044817
    },
    "resHeaders": { ... },
    "headers": { ... },
    "header": [ { "key": "...", "value": "..." } ],
    "resMime": {
        "ext": "json",
        "mime": "application/json"
    },
    "rawCookies": [ { "name": "...", "value": "...", "expires": "...", "path": "...", "domain": "..." } ]
}

  12. Understand the purpose and execution of Post-execution scripts in ApiPost

    Post-execution scripts are custom JavaScript scripts that execute automatically after an HTTP request has been sent. They are used to perform actions based on the request's outcome, such as validating responses, managing variables, or triggering subsequent requests.