Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Real-time Collaborations
  • Apidog Learning Center
  • Get started
    • Introduce Apidog
    • Basic concepts in Apidog
    • Navigating Apidog
    • Quick Start
      • Overview
      • Specify a new endpoint
      • Make a request to the endpoint
      • Add an assertion
      • Create a test scenario
      • Share your API documentation
      • Explore more
      • Send a request and save as an endpoint
    • Migration
      • Overview
      • Manual import
      • Scheduled import
      • Import options
      • Export data
      • Import from...
        • Import from Postman
        • Import OpenAPI (Swagger) spec
        • Import cURL
        • Import Markdowns
        • Import from Insomnia
        • Import from apiDoc
        • Import .har file
        • Import WSDL
  • Design APIs
    • Overview
    • Create a new API project
    • Endpoint basics
    • Components
    • Common fields
    • Global parameters
    • Endpoint change history
    • Batch endpoint management
    • Configure multiple request body examples
    • Schemas
      • Generate Schemas from JSON etc.
      • Build a schema
      • Overview
      • Create a new schema
    • Security schemes
      • Overview
      • Create a security scheme
      • Use the security scheme
      • Security scheme in online documentation
    • Advanced features
      • Custom endpoint fields
      • Import endpoints as test steps
      • Endpoint status
      • Appearance of parameter lists
      • Endpoint unique idenfication
  • Develop and Debug APIs
    • Overview
    • Generate requests
    • Send requests
    • Endpoint cases
    • Dynamic values
    • Validate responses
    • Design-first Mode & Request-first Mode
    • Generate code
    • Environments & variables
      • Overview
      • Using variables
      • Environments & services
    • Vault secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre/Post processors
      • Overview
      • Assertion
      • Extract variable
      • Wait
      • Database operations
        • Overview
        • MongoDB
        • Redis
        • Oracle Client
      • Using scripts
        • Overview
        • Postman scripts reference
        • Pre processor scripts
        • Post processor scripts
        • Public scripts
        • Calling other programming languages
        • Using JS libraries
        • Visualizing responses
        • Script examples
          • Assertion scripts
          • Using variables in scripts
          • Using scripts to modify request messages
          • Other examples
    • Dynamic values Modules
  • Mock API data
    • Overview
    • Smart mock
    • Custom mock
    • Mock priority sequence
    • Mock scripts
    • Cloud mock
    • Self-hosted runner mock
    • Mock language (Locales)
  • Automated tests
    • Overview
    • Test reports
    • Test scenarios
      • Create a test scenario
      • Pass data between requests
      • Flow control conditions
      • Import endpoints/endpoint cases from other projects
      • Sync data from endpoints/endpoint cases
      • Export test scenarios
    • Run test scenarios
      • Run a test scenario
      • Data-driven testing
      • Run test scenarios in batch
      • Scheduled tasks
      • Manage the runtime environment of APIs from other projects
    • Test APIs
      • Integration testing
      • Performance testing
      • End-to-end testing
      • Regression testing
    • Apidog CLI
      • Overview
      • Installing and running Apidog CLI
      • Apidog CLI Options
    • CI/CD
      • Overview
      • Integrate with Jenkins
      • Integration with Gitlab
  • Publish API Docs
    • Overview
    • API Technologies Supported
    • Quick share
    • View the API documentation
    • Publish docs sites
    • Folder tree settings
    • Custom layouts
    • Visibility settings
    • Endpoint SEO settings
    • Custom domain
    • Embedding values in document URLs
    • Documentation Search
    • Integrating Google Analytics with Doc Sites
    • CORS Proxy
    • API Versions
      • Overview
      • Create API versions
      • Publish API versions
      • Share endpoints with API versions
  • Send requests
    • Overview
    • gRPC
    • Use request proxy agents for debugging
    • SOAP/WebService
    • GraphQL
    • WebSocket
    • Socket.IO
    • SSE debugging
    • Create requests
      • Request History
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • HTTP/2
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
      • Debug requests
      • Save the request as an endpoint
  • Branches
    • Overview
    • Create a new sprint branch
    • Test APIs in a branch
    • Design API in a branch
    • Merge sprint branches
    • Manage sprint branches
  • Apidog MCP Server
    • Overview
    • Conntect API Specification within Apidog Project to AI via Apidog MCP Server
    • Conntect Online API Documentation Published by Apidog to AI via Apidog MCP Server
    • Conntect OpenAPI Files to AI via Apidog MCP Server
  • Best practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Administration
    • Onboarding Checklist
      • Basic Concepts
      • Onboarding Guide
    • Managing Teams
      • Managing Teams
      • Managing Team Members
      • Member Roles & Permission Settings
      • Team Activities
      • Team Resources
        • General Runner
        • Team Variables
        • Request Proxy Agent
      • Real-time Collaborations
        • Team Collaboration
    • Managing Projects
      • Managing Projects
      • Managing Project Members
      • Notification Settings
      • Project Resources
        • Database Connection
    • Managing Organizations
      • Single Sign-On (SSO)
        • SSO Overview
        • Configure Microsoft Entra ID
        • Configure Okta
        • Configure SSO for an Organization
        • Managing user accounts
        • Mapping Groups to Teams
      • SCIM Provisioning
        • Intro to SCIM Provisioning
        • Microsoft Entra ID
        • Okta
      • Organization Resources
        • Self-hosted Runner
  • Billing
    • Overview
    • Credits
    • Unable to use credit cards?
    • Managing subscriptions
    • Upgrade plan
  • Add-ons
    • API Hub
    • Apidog Intellij IDEA plugin
    • Browser Extension
      • Chrome
      • Microsoft Edge
    • Request Proxy
      • Request proxy in Apidog web
      • Request proxy in shared docs
      • Request proxy in Apidog client
  • Account & preferences
    • Language settings
    • Data backup
    • Network proxy configuration
    • Hot keys
    • Updating Apidog
    • Generate OpenAPI access token
    • Deleting account
    • Account settings
  • References
    • API-Design First Approach
    • Apidog OpenAPI/Swagger Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  • Apidog Europe
    • Apidog Europe
  • Support Center
  1. Real-time Collaborations

Team Collaboration

Multi-User collaboration & real-time sync#

The real-time collaboration capability of the API documentation helps improve work efficiency for R&D teams and reduces the cost of repeated communication. The HTTP API and data model modules in the API management support multi-user online real-time collaboration. When others save data, the current page will automatically update changes made by other team members.

Applicable scenarios#

In the following scenarios, the new API documentation will be automatically synced to team members without the need for manual global refresh:
Modifying and saving an API within the App
After periodically importing Swagger/OpenAPI files

Hightlights#

Compared to other similar products, Apidog's multi-user collaboration features have the following significant advantages:
Real-time display of editor avatars, clearly showing who is editing the same API
Field-level collaboration, effectively avoiding content conflicts
If there is a conflict, you'll know during editing so you can resolve it beforehand and continue editing
Fine-grained conflict resolution, allowing preservation of partial content from both sides
API documentation has version history and recycle bin, supporting rollback to old versions, no need to worry about accidental modifications
Automatic import and the IDEA plugin are also part of real-time collaboration, data is automatically updated after import

Collaboration links#

The "Collaboration Link" feature allows members of the team to quickly locate APIs and collaborate.
Collaboration links are only used for sharing within the team, and non-team members can't open the collaboration link.

Copy the collaboration link#

Tap the "Copy Collaboration Link" button in the menu bar on the right side of the API to create a collaboration link. Send it to other team members, open the link, and you can directly locate the corresponding API in the web terminal.

Link URL Specification#

Apidog links are composed of several key components:
1.
Project ID
Example: https://apidog.com/web/project/{Project-ID}
2.
Specified Endpoint within the Project
Example: https://apidog.com/web/project/{Project-ID}/apis/api-{API-ID}
3.
Specified Tab within an Endpoint
Example: https://apidog.com/web/project/{Project-ID}/apis/api-{API-ID}-run
This URL structure allows users to access specific projects, APIs, and views within the Apidog platform.

Embedding Parameter Values in URLs#

When sharing Apidog endpoints, the default behavior is to only include the API specification without any parameter values. However, if you need to share the document with specific parameter or variable values included, you can embed them directly in the document URL.

Passing Parameter Values#

There are two approaches to embedding parameter values in the URL - the simple mode and the complex mode. The simple mode is more straightforward and does not require URL encoding, but it does not support bracket characters. The complex mode supports all characters but requires encoding the parameter data.

Simple Mode#

In the simple mode, you can use the format query[xxx]=yyy to assign the value yyy to the parameter named xxx.
Example:
https://apidog.com/web/project/406014/apis/api-10061199-run?query[aaa]=yyy&query[bbb]=yyy&path[aaa]=yyy&body[aaa]=yyy&header[aaa]=yyy&cookie[aaa]=yyy&environment[aaa]=yyy
Parameter TypeParameter ValueDescription
Query Parametersquery[xxx]=yyy
Path Parameterspath[xxx]=yyy
Body Parametersbody[xxx]=yyyFor form-data or x-www-urlencoded body types
Body Parametersbody=yyyFor other body types
Header Parametersheader[xxx]=yyy
Cookie Parameterscookie[xxx]=yyy
Environment Variablesenvironment[xxx]=yyyThese will be saved to the default environment variables

Complex Mode#

The complex mode allows for more advanced parameter embedding by encoding a JSON object. The value of the params parameter is obtained by calling encodeURIComponent on the following JSON data:
{
    "query": [
        ["id", "value1"], 
        ["id", "value2"], 
        ["key2", "value3"]
    ],
    "path": [
        ["key1", "value1"], 
        ["key2", "value2"]
    ],
    "body": [
        ["aaa", "value1"], 
        ["key2", "value2"]
    ],
    "header": [
        ["testHeader", "value1"], 
        ["key2", "value2"]
    ], 
    "cookie": [
        ["testCookie", "value1"], 
        ["key2", "value2"]
    ], 
    "environment": [
        ["key1", "value1"], 
        ["key2", "value2"]
    ]
}
The encoded URL would look like:
https://apidog.com/web/project/406014/apis/api-10061199-run?params={ "query"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "body"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "cookie"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "environment"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" } }
Parameters TypeParameters ValueDescription
Query Parametersquery
Path Parameterspath
Body ParametersbodyIf the body type is form-data or x-www-urlencoded, the value of body is JSON; otherwise the value of body is a string
Header Parametersheader
Cookie Parameterscookie
Environment VariablesenvironmentThese will be saved to the default environment variables

Passing Environment Variables#

You can also use the URL to automatically set the user's "environment variables" by passing parameters. To do this, add URL parameters in the format environment[variable name]=variable value.
For example:
https://apidog.com/web/project/406014?environment[aaa]=xxx&environment[bbb]=yyy
https://apidog.com/web/project/406014/apis/api-10061199-run?environment[aaa]=xxx

Change the opening method#

Collaboration links support opening in both the client and the web side. If you want to locate the API through the client, go to Apidog Web, tap the "Settings"βš™, and turn on the "Always open collaboration links on desktop" option in "General".
This option is only available on Apidog Web but not Apidog Client.
The client will be automatically evoked when the collaboration link is accessed.
Modified atΒ 2025-02-19 09:48:29
Previous
Request Proxy Agent
Next
Managing Projects
Built with