DOCSEARCHbyAlgolia
Submit Docs

Postcat API Client

website·Indexed 32 days ago

https://docs.postcat.com/

An open-source, cross-platform API client for Windows, Mac, and Linux. It features API editing, interface testing, Mock services, environment management, global variables, and an extensible plugin system.

Tokens
2.6K
Snippets
16
Records
31
Agent score
55%

What's inside Postcat

  1. Postcat core features and capabilities

    Postcat provides a comprehensive suite for API lifecycle management, including:

    • API Design and Documentation
    • API Testing and Mocking
    • Team Collaboration and Document Sharing
    • Environment and Global Variable management
    • Custom Theme Styles and Multi-language support (Chinese, English)
    • A plugin system that allows users to install third-party extensions or develop custom plugins to enhance functionality.

  2. Extend Postcat functionality using the Extension Marketplace

    Postcat features a plugin mechanism that allows users to freely extend and customize the application's functionality to meet specific needs. Plugins serve different purposes and may appear in different UI areas with unique interactions. Users can browse the full plugin list, manage installed plugins, and configure specific plugin settings within the Extension Marketplace.

  3. Postcat supported protocols and features

    Postcat supports API development, testing, and documentation.

    Currently Supported Protocols:

    • HTTP REST
    • WebSocket

    Planned Protocols:

    • GraphQL
    • TCP
    • UDP
    • gRPC

    Key Features:

    • API Design and Testing
    • Mocking
    • Team Collaboration and Document Sharing
    • Environment and Global Variable management
    • Custom themes and multi-language support (Chinese, English)
    • Plugin system for extending functionality.

  4. Use and reference global variables in PostCat

    Global variables in PostCat allow for dynamic value retrieval and assignment during the testing process. They can be referenced in request information using double curly braces (e.g., {{variable_name}}) or accessed via script code.

    Custom global variables have the following characteristics:

    1. They are independent of the environment and can be used even if no environment is selected.
    2. They are stored locally in the client; clearing the browser cache will also clear custom global variables.
    3. Current values can be viewed by clicking the environment preview button in the top right corner of the page.

  5. Perform basic API testing in Postcat

    To test an API in Postcat, you can either create a new test tab by clicking the plus (+) icon on the tab bar or quickly initiate a test by clicking the lightning icon next to a grouped API.

    When configuring the request, ensure the following are set:

    1. Request URL and Method: Define the endpoint and the HTTP method (GET, POST, etc.).
    2. Query Parameters: If parameters are included in the API Path, Postcat automatically synchronizes them into the Query parameters table.
    3. Request Headers: Configure necessary HTTP headers.
    4. Request Body: Select the appropriate format (e.g., JSON) before clicking the test button.

    After execution, Postcat displays the Status Code, Response Body, and Response Time to help determine if the API is functioning as expected.

  6. Define Query parameters in Postcat

    Query parameters are the key-value pairs following the ? in the URL. You can import them in bulk using the format ?key=value, separating multiple parameters with &.
    api.eolinker.com/user/login?user_name=jackliu&user_password=hello

  7. Review and reuse API test history in Postcat

    Postcat allows you to access the 'Test History' feature to backtrack and view all request information from previous API tests, enabling quick regression testing.

  9. Install Postcat plugins in an offline environment

    Postcat supports offline plugin installation exclusively for the desktop version. To move plugins to an offline machine, follow these steps:

    1. Install the required plugins on a machine with internet access.
    2. Locate the .postcat folder in your user directory ({user}/.postcat) and copy its contents.
    3. Paste the copied contents into the .postcat folder within the user directory of the offline machine to complete the installation.

  10. Define REST path parameters in Postcat

    REST parameters are path segments separated by slashes. In the URL field, wrap these parameters in curly braces {}. Note: When filling in the corresponding parameter name in the form, do not include the curly braces.
    /user/login/{user_name}/{user_password}

  11. Extend Postcat functionality via the plugin system

    Postcat features an extensible plugin system that allows developers to customize their toolset by adding or removing specific features. Users can either install existing plugins from the plugin marketplace or develop their own custom extensions to meet specific project requirements.

  12. Install or access Postcat API Client

    Postcat is an open-source, cross-platform API development and testing tool available for Windows, Mac, and Linux. It can also be used directly in a web browser via the official website.
    Visit https://postcat.com/ to download the desktop client or use the Web version.